stau.space
Distributed File System written in C
1# Doxyfile 1.14.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
37DOXYFILE_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
45PROJECT_NAME = "Distributed File System"
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
51PROJECT_NUMBER = 1
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 viewers a
55# quick idea about the purpose of the project. Keep the description short.
56
57PROJECT_BRIEF = "Distributed file system in C"
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
64PROJECT_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
70PROJECT_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
77OUTPUT_DIRECTORY = docs
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 cause
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
88CREATE_SUBDIRS = YES
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
99CREATE_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
107ALLOW_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
122OUTPUT_LANGUAGE = English
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
129BRIEF_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
138REPEAT_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
149ABBREVIATE_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
166ALWAYS_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
174INLINE_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
181FULL_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
193STRIP_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
202STRIP_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 if your file system doesn't
206# support long names like on DOS, Mac, or CD-ROM.
207# The default value is: NO.
208
209SHORT_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, question mark or exclamation mark) of a
213# Javadoc-style comment as the brief description. If set to NO, the Javadoc-
214# style will behave just like regular Qt-style comments (thus requiring an
215# explicit @brief command for a brief description.)
216# The default value is: NO.
217
218JAVADOC_AUTOBRIEF = YES
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
228JAVADOC_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, question mark or exclamation mark) of a Qt-style
232# comment as the brief description. If set to NO, the Qt-style will behave just
233# like regular Qt-style comments (thus requiring an explicit \brief command for
234# a brief description.)
235# The default value is: NO.
236
237QT_AUTOBRIEF = NO
238
239# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen treat a
240# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
241# a brief description. This used to be the default behavior. The new default is
242# to treat a multi-line C++ comment block as a detailed description. Set this
243# tag to YES if you prefer the old behavior instead.
244#
245# Note that setting this tag to YES also means that rational rose comments are
246# not recognized any more.
247# The default value is: NO.
248
249MULTILINE_CPP_IS_BRIEF = NO
250
251# By default Python docstrings are displayed as preformatted text and Doxygen's
252# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
253# Doxygen's special commands can be used and the contents of the docstring
254# documentation blocks is shown as Doxygen documentation.
255# The default value is: YES.
256
257PYTHON_DOCSTRING = YES
258
259# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
260# documentation from any documented member that it re-implements.
261# The default value is: YES.
262
263INHERIT_DOCS = YES
264
265# If the SEPARATE_MEMBER_PAGES tag is set to YES then Doxygen will produce a new
266# page for each member. If set to NO, the documentation of a member will be part
267# of the file/class/namespace that contains it.
268# The default value is: NO.
269
270SEPARATE_MEMBER_PAGES = NO
271
272# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
273# uses this value to replace tabs by spaces in code fragments.
274# Minimum value: 1, maximum value: 16, default value: 4.
275
276TAB_SIZE = 4
277
278# This tag can be used to specify a number of aliases that act as commands in
279# the documentation. An alias has the form:
280# name=value
281# For example adding
282# "sideeffect=@par Side Effects:^^"
283# will allow you to put the command \sideeffect (or @sideeffect) in the
284# documentation, which will result in a user-defined paragraph with heading
285# "Side Effects:". Note that you cannot put \n's in the value part of an alias
286# to insert newlines (in the resulting output). You can put ^^ in the value part
287# of an alias to insert a newline as if a physical newline was in the original
288# file. When you need a literal { or } or , in the value part of an alias you
289# have to escape them by means of a backslash (\), this can lead to conflicts
290# with the commands \{ and \} for these it is advised to use the version @{ and
291# @} or use a double escape (\\{ and \\})
292
293ALIASES =
294
295# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
296# only. Doxygen will then generate output that is more tailored for C. For
297# instance, some of the names that are used will be different. The list of all
298# members will be omitted, etc.
299# The default value is: NO.
300
301OPTIMIZE_OUTPUT_FOR_C = NO
302
303# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
304# Python sources only. Doxygen will then generate output that is more tailored
305# for that language. For instance, namespaces will be presented as packages,
306# qualified scopes will look different, etc.
307# The default value is: NO.
308
309OPTIMIZE_OUTPUT_JAVA = NO
310
311# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
312# sources. Doxygen will then generate output that is tailored for Fortran.
313# The default value is: NO.
314
315OPTIMIZE_FOR_FORTRAN = NO
316
317# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
318# sources. Doxygen will then generate output that is tailored for VHDL.
319# The default value is: NO.
320
321OPTIMIZE_OUTPUT_VHDL = NO
322
323# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
324# sources only. Doxygen will then generate output that is more tailored for that
325# language. For instance, namespaces will be presented as modules, types will be
326# separated into more groups, etc.
327# The default value is: NO.
328
329OPTIMIZE_OUTPUT_SLICE = NO
330
331# Doxygen selects the parser to use depending on the extension of the files it
332# parses. With this tag you can assign which parser to use for a given
333# extension. Doxygen has a built-in mapping, but you can override or extend it
334# using this tag. The format is ext=language, where ext is a file extension, and
335# language is one of the parsers supported by Doxygen: IDL, Java, JavaScript,
336# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
337# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
338# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
339# tries to guess whether the code is fixed or free formatted code, this is the
340# default for Fortran type files). For instance to make Doxygen treat .inc files
341# as Fortran files (default is PHP), and .f files as C (default is Fortran),
342# use: inc=Fortran f=C.
343#
344# Note: For files without extension you can use no_extension as a placeholder.
345#
346# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
347# the files are not read by Doxygen. When specifying no_extension you should add
348# * to the FILE_PATTERNS.
349#
350# Note see also the list of default file extension mappings.
351
352EXTENSION_MAPPING =
353
354# If the MARKDOWN_SUPPORT tag is enabled then Doxygen pre-processes all comments
355# according to the Markdown format, which allows for more readable
356# documentation. See https://daringfireball.net/projects/markdown/ for details.
357# The output of markdown processing is further processed by Doxygen, so you can
358# mix Doxygen, HTML, and XML commands with Markdown formatting. Disable only in
359# case of backward compatibilities issues.
360# The default value is: YES.
361
362MARKDOWN_SUPPORT = YES
363
364# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
365# to that level are automatically included in the table of contents, even if
366# they do not have an id attribute.
367# Note: This feature currently applies only to Markdown headings.
368# Minimum value: 0, maximum value: 99, default value: 6.
369# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
370
371TOC_INCLUDE_HEADINGS = 6
372
373# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
374# generate identifiers for the Markdown headings. Note: Every identifier is
375# unique.
376# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
377# sequence number starting at 0 and GITHUB use the lower case version of title
378# with any whitespace replaced by '-' and punctuation characters removed.
379# The default value is: DOXYGEN.
380# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
381
382MARKDOWN_ID_STYLE = DOXYGEN
383
384# When enabled Doxygen tries to link words that correspond to documented
385# classes, or namespaces to their corresponding documentation. Such a link can
386# be prevented in individual cases by putting a % sign in front of the word or
387# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the
388# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking.
389# The default value is: YES.
390
391AUTOLINK_SUPPORT = YES
392
393# This tag specifies a list of words that, when matching the start of a word in
394# the documentation, will suppress auto links generation, if it is enabled via
395# AUTOLINK_SUPPORT. This list does not affect links explicitly created using \#
396# or the \link or commands.
397# This tag requires that the tag AUTOLINK_SUPPORT is set to YES.
398
399AUTOLINK_IGNORE_WORDS =
400
401# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
402# to include (a tag file for) the STL sources as input, then you should set this
403# tag to YES in order to let Doxygen match functions declarations and
404# definitions whose arguments contain STL classes (e.g. func(std::string);
405# versus func(std::string) {}). This also makes the inheritance and
406# collaboration diagrams that involve STL classes more complete and accurate.
407# The default value is: NO.
408
409BUILTIN_STL_SUPPORT = NO
410
411# If you use Microsoft's C++/CLI language, you should set this option to YES to
412# enable parsing support.
413# The default value is: NO.
414
415CPP_CLI_SUPPORT = NO
416
417# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
418# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse
419# them like normal C++ but will assume all classes use public instead of private
420# inheritance when no explicit protection keyword is present.
421# The default value is: NO.
422
423SIP_SUPPORT = NO
424
425# For Microsoft's IDL there are propget and propput attributes to indicate
426# getter and setter methods for a property. Setting this option to YES will make
427# Doxygen to replace the get and set methods by a property in the documentation.
428# This will only work if the methods are indeed getting or setting a simple
429# type. If this is not the case, or you want to show the methods anyway, you
430# should set this option to NO.
431# The default value is: YES.
432
433IDL_PROPERTY_SUPPORT = YES
434
435# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
436# tag is set to YES then Doxygen will reuse the documentation of the first
437# member in the group (if any) for the other members of the group. By default
438# all members of a group must be documented explicitly.
439# The default value is: NO.
440
441DISTRIBUTE_GROUP_DOC = NO
442
443# If one adds a struct or class to a group and this option is enabled, then also
444# any nested class or struct is added to the same group. By default this option
445# is disabled and one has to add nested compounds explicitly via \ingroup.
446# The default value is: NO.
447
448GROUP_NESTED_COMPOUNDS = NO
449
450# Set the SUBGROUPING tag to YES to allow class member groups of the same type
451# (for instance a group of public functions) to be put as a subgroup of that
452# type (e.g. under the Public Functions section). Set it to NO to prevent
453# subgrouping. Alternatively, this can be done per class using the
454# \nosubgrouping command.
455# The default value is: YES.
456
457SUBGROUPING = YES
458
459# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
460# are shown inside the group in which they are included (e.g. using \ingroup)
461# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
462# and RTF).
463#
464# Note that this feature does not work in combination with
465# SEPARATE_MEMBER_PAGES.
466# The default value is: NO.
467
468INLINE_GROUPED_CLASSES = NO
469
470# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
471# with only public data fields or simple typedef fields will be shown inline in
472# the documentation of the scope in which they are defined (i.e. file,
473# namespace, or group documentation), provided this scope is documented. If set
474# to NO, structs, classes, and unions are shown on a separate page (for HTML and
475# Man pages) or section (for LaTeX and RTF).
476# The default value is: NO.
477
478INLINE_SIMPLE_STRUCTS = NO
479
480# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
481# enum is documented as struct, union, or enum with the name of the typedef. So
482# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
483# with name TypeT. When disabled the typedef will appear as a member of a file,
484# namespace, or class. And the struct will be named TypeS. This can typically be
485# useful for C code in case the coding convention dictates that all compound
486# types are typedef'ed and only the typedef is referenced, never the tag name.
487# The default value is: NO.
488
489TYPEDEF_HIDES_STRUCT = NO
490
491# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
492# cache is used to resolve symbols given their name and scope. Since this can be
493# an expensive process and often the same symbol appears multiple times in the
494# code, Doxygen keeps a cache of pre-resolved symbols. If the cache is too small
495# Doxygen will become slower. If the cache is too large, memory is wasted. The
496# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
497# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
498# symbols. At the end of a run Doxygen will report the cache usage and suggest
499# the optimal cache size from a speed point of view.
500# Minimum value: 0, maximum value: 9, default value: 0.
501
502LOOKUP_CACHE_SIZE = 0
503
504# The NUM_PROC_THREADS specifies the number of threads Doxygen is allowed to use
505# during processing. When set to 0 Doxygen will based this on the number of
506# cores available in the system. You can set it explicitly to a value larger
507# than 0 to get more control over the balance between CPU load and processing
508# speed. At this moment only the input processing can be done using multiple
509# threads. Since this is still an experimental feature the default is set to 1,
510# which effectively disables parallel processing. Please report any issues you
511# encounter. Generating dot graphs in parallel is controlled by the
512# DOT_NUM_THREADS setting.
513# Minimum value: 0, maximum value: 32, default value: 1.
514
515NUM_PROC_THREADS = 1
516
517# If the TIMESTAMP tag is set different from NO then each generated page will
518# contain the date or date and time when the page was generated. Setting this to
519# NO can help when comparing the output of multiple runs.
520# Possible values are: YES, NO, DATETIME and DATE.
521# The default value is: NO.
522
523TIMESTAMP = NO
524
525#---------------------------------------------------------------------------
526# Build related configuration options
527#---------------------------------------------------------------------------
528
529# If the EXTRACT_ALL tag is set to YES, Doxygen will assume all entities in
530# documentation are documented, even if no documentation was available. Private
531# class members and static file members will be hidden unless the
532# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
533# Note: This will also disable the warnings about undocumented members that are
534# normally produced when WARNINGS is set to YES.
535# The default value is: NO.
536
537EXTRACT_ALL = YES
538
539# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
540# be included in the documentation.
541# The default value is: NO.
542
543EXTRACT_PRIVATE = YES
544
545# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
546# methods of a class will be included in the documentation.
547# The default value is: NO.
548
549EXTRACT_PRIV_VIRTUAL = YES
550
551# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
552# scope will be included in the documentation.
553# The default value is: NO.
554
555EXTRACT_PACKAGE = NO
556
557# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
558# included in the documentation.
559# The default value is: NO.
560
561EXTRACT_STATIC = YES
562
563# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
564# locally in source files will be included in the documentation. If set to NO,
565# only classes defined in header files are included. Does not have any effect
566# for Java sources.
567# The default value is: YES.
568
569EXTRACT_LOCAL_CLASSES = YES
570
571# This flag is only useful for Objective-C code. If set to YES, local methods,
572# which are defined in the implementation section but not in the interface are
573# included in the documentation. If set to NO, only methods in the interface are
574# included.
575# The default value is: NO.
576
577EXTRACT_LOCAL_METHODS = NO
578
579# If this flag is set to YES, the members of anonymous namespaces will be
580# extracted and appear in the documentation as a namespace called
581# 'anonymous_namespace{file}', where file will be replaced with the base name of
582# the file that contains the anonymous namespace. By default anonymous namespace
583# are hidden.
584# The default value is: NO.
585
586EXTRACT_ANON_NSPACES = NO
587
588# If this flag is set to YES, the name of an unnamed parameter in a declaration
589# will be determined by the corresponding definition. By default unnamed
590# parameters remain unnamed in the output.
591# The default value is: YES.
592
593RESOLVE_UNNAMED_PARAMS = YES
594
595# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
596# undocumented members inside documented classes or files. If set to NO these
597# members will be included in the various overviews, but no documentation
598# section is generated. This option has no effect if EXTRACT_ALL is enabled.
599# The default value is: NO.
600
601HIDE_UNDOC_MEMBERS = NO
602
603# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
604# undocumented classes that are normally visible in the class hierarchy. If set
605# to NO, these classes will be included in the various overviews. This option
606# will also hide undocumented C++ concepts if enabled. This option has no effect
607# if EXTRACT_ALL is enabled.
608# The default value is: NO.
609
610HIDE_UNDOC_CLASSES = NO
611
612# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all
613# undocumented namespaces that are normally visible in the namespace hierarchy.
614# If set to NO, these namespaces will be included in the various overviews. This
615# option has no effect if EXTRACT_ALL is enabled.
616# The default value is: YES.
617
618HIDE_UNDOC_NAMESPACES = YES
619
620# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend
621# declarations. If set to NO, these declarations will be included in the
622# documentation.
623# The default value is: NO.
624
625HIDE_FRIEND_COMPOUNDS = NO
626
627# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
628# documentation blocks found inside the body of a function. If set to NO, these
629# blocks will be appended to the function's detailed documentation block.
630# The default value is: NO.
631
632HIDE_IN_BODY_DOCS = NO
633
634# The INTERNAL_DOCS tag determines if documentation that is typed after a
635# \internal command is included. If the tag is set to NO then the documentation
636# will be excluded. Set it to YES to include the internal documentation.
637# The default value is: NO.
638
639INTERNAL_DOCS = NO
640
641# With the correct setting of option CASE_SENSE_NAMES Doxygen will better be
642# able to match the capabilities of the underlying filesystem. In case the
643# filesystem is case sensitive (i.e. it supports files in the same directory
644# whose names only differ in casing), the option must be set to YES to properly
645# deal with such files in case they appear in the input. For filesystems that
646# are not case sensitive the option should be set to NO to properly deal with
647# output files written for symbols that only differ in casing, such as for two
648# classes, one named CLASS and the other named Class, and to also support
649# references to files without having to specify the exact matching casing. On
650# Windows (including Cygwin) and macOS, users should typically set this option
651# to NO, whereas on Linux or other Unix flavors it should typically be set to
652# YES.
653# Possible values are: SYSTEM, NO and YES.
654# The default value is: SYSTEM.
655
656CASE_SENSE_NAMES = SYSTEM
657
658# If the HIDE_SCOPE_NAMES tag is set to NO then Doxygen will show members with
659# their full class and namespace scopes in the documentation. If set to YES, the
660# scope will be hidden.
661# The default value is: NO.
662
663HIDE_SCOPE_NAMES = NO
664
665# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then Doxygen will
666# append additional text to a page's title, such as Class Reference. If set to
667# YES the compound reference will be hidden.
668# The default value is: NO.
669
670HIDE_COMPOUND_REFERENCE= NO
671
672# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
673# will show which file needs to be included to use the class.
674# The default value is: YES.
675
676SHOW_HEADERFILE = YES
677
678# If the SHOW_INCLUDE_FILES tag is set to YES then Doxygen will put a list of
679# the files that are included by a file in the documentation of that file.
680# The default value is: YES.
681
682SHOW_INCLUDE_FILES = YES
683
684# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
685# grouped member an include statement to the documentation, telling the reader
686# which file to include in order to use the member.
687# The default value is: NO.
688
689SHOW_GROUPED_MEMB_INC = NO
690
691# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include
692# files with double quotes in the documentation rather than with sharp brackets.
693# The default value is: NO.
694
695FORCE_LOCAL_INCLUDES = NO
696
697# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
698# documentation for inline members.
699# The default value is: YES.
700
701INLINE_INFO = YES
702
703# If the SORT_MEMBER_DOCS tag is set to YES then Doxygen will sort the
704# (detailed) documentation of file and class members alphabetically by member
705# name. If set to NO, the members will appear in declaration order.
706# The default value is: YES.
707
708SORT_MEMBER_DOCS = YES
709
710# If the SORT_BRIEF_DOCS tag is set to YES then Doxygen will sort the brief
711# descriptions of file, namespace and class members alphabetically by member
712# name. If set to NO, the members will appear in declaration order. Note that
713# this will also influence the order of the classes in the class list.
714# The default value is: NO.
715
716SORT_BRIEF_DOCS = NO
717
718# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then Doxygen will sort the
719# (brief and detailed) documentation of class members so that constructors and
720# destructors are listed first. If set to NO the constructors will appear in the
721# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
722# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
723# member documentation.
724# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
725# detailed member documentation.
726# The default value is: NO.
727
728SORT_MEMBERS_CTORS_1ST = NO
729
730# If the SORT_GROUP_NAMES tag is set to YES then Doxygen will sort the hierarchy
731# of group names into alphabetical order. If set to NO the group names will
732# appear in their defined order.
733# The default value is: NO.
734
735SORT_GROUP_NAMES = NO
736
737# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
738# fully-qualified names, including namespaces. If set to NO, the class list will
739# be sorted only by class name, not including the namespace part.
740# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
741# Note: This option applies only to the class list, not to the alphabetical
742# list.
743# The default value is: NO.
744
745SORT_BY_SCOPE_NAME = NO
746
747# If the STRICT_PROTO_MATCHING option is enabled and Doxygen fails to do proper
748# type resolution of all parameters of a function it will reject a match between
749# the prototype and the implementation of a member function even if there is
750# only one candidate or it is obvious which candidate to choose by doing a
751# simple string match. By disabling STRICT_PROTO_MATCHING Doxygen will still
752# accept a match between prototype and implementation in such cases.
753# The default value is: NO.
754
755STRICT_PROTO_MATCHING = NO
756
757# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
758# list. This list is created by putting \todo commands in the documentation.
759# The default value is: YES.
760
761GENERATE_TODOLIST = YES
762
763# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
764# list. This list is created by putting \test commands in the documentation.
765# The default value is: YES.
766
767GENERATE_TESTLIST = YES
768
769# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
770# list. This list is created by putting \bug commands in the documentation.
771# The default value is: YES.
772
773GENERATE_BUGLIST = YES
774
775# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
776# the deprecated list. This list is created by putting \deprecated commands in
777# the documentation.
778# The default value is: YES.
779
780GENERATE_DEPRECATEDLIST= YES
781
782# The ENABLED_SECTIONS tag can be used to enable conditional documentation
783# sections, marked by \if <section_label> ... \endif and \cond <section_label>
784# ... \endcond blocks.
785
786ENABLED_SECTIONS =
787
788# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
789# initial value of a variable or macro / define can have for it to appear in the
790# documentation. If the initializer consists of more lines than specified here
791# it will be hidden. Use a value of 0 to hide initializers completely. The
792# appearance of the value of individual variables and macros / defines can be
793# controlled using \showinitializer or \hideinitializer command in the
794# documentation regardless of this setting.
795# Minimum value: 0, maximum value: 10000, default value: 30.
796
797MAX_INITIALIZER_LINES = 30
798
799# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
800# the bottom of the documentation of classes and structs. If set to YES, the
801# list will mention the files that were used to generate the documentation.
802# The default value is: YES.
803
804SHOW_USED_FILES = YES
805
806# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
807# will remove the Files entry from the Quick Index and from the Folder Tree View
808# (if specified).
809# The default value is: YES.
810
811SHOW_FILES = YES
812
813# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
814# page. This will remove the Namespaces entry from the Quick Index and from the
815# Folder Tree View (if specified).
816# The default value is: YES.
817
818SHOW_NAMESPACES = YES
819
820# The FILE_VERSION_FILTER tag can be used to specify a program or script that
821# Doxygen should invoke to get the current version for each file (typically from
822# the version control system). Doxygen will invoke the program by executing (via
823# popen()) the command command input-file, where command is the value of the
824# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
825# by Doxygen. Whatever the program writes to standard output is used as the file
826# version. For an example see the documentation.
827
828FILE_VERSION_FILTER =
829
830# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
831# by Doxygen. The layout file controls the global structure of the generated
832# output files in an output format independent way. To create the layout file
833# that represents Doxygen's defaults, run Doxygen with the -l option. You can
834# optionally specify a file name after the option, if omitted DoxygenLayout.xml
835# will be used as the name of the layout file. See also section "Changing the
836# layout of pages" for information.
837#
838# Note that if you run Doxygen from a directory containing a file called
839# DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
840# tag is left empty.
841
842LAYOUT_FILE =
843
844# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
845# the reference definitions. This must be a list of .bib files. The .bib
846# extension is automatically appended if omitted. This requires the bibtex tool
847# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
848# For LaTeX the style of the bibliography can be controlled using
849# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
850# search path. See also \cite for info how to create references.
851
852CITE_BIB_FILES =
853
854# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH
855# environment variable) so that external tools such as latex and gs can be
856# found.
857# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the
858# path already specified by the PATH variable, and are added in the order
859# specified.
860# Note: This option is particularly useful for macOS version 14 (Sonoma) and
861# higher, when running Doxygen from Doxywizard, because in this case any user-
862# defined changes to the PATH are ignored. A typical example on macOS is to set
863# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin
864# together with the standard path, the full search path used by doxygen when
865# launching external tools will then become
866# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
867
868EXTERNAL_TOOL_PATH =
869
870#---------------------------------------------------------------------------
871# Configuration options related to warning and progress messages
872#---------------------------------------------------------------------------
873
874# The QUIET tag can be used to turn on/off the messages that are generated to
875# standard output by Doxygen. If QUIET is set to YES this implies that the
876# messages are off.
877# The default value is: NO.
878
879QUIET = NO
880
881# The WARNINGS tag can be used to turn on/off the warning messages that are
882# generated to standard error (stderr) by Doxygen. If WARNINGS is set to YES
883# this implies that the warnings are on.
884#
885# Tip: Turn warnings on while writing the documentation.
886# The default value is: YES.
887
888WARNINGS = YES
889
890# If the WARN_IF_UNDOCUMENTED tag is set to YES then Doxygen will generate
891# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
892# will automatically be disabled.
893# The default value is: YES.
894
895WARN_IF_UNDOCUMENTED = YES
896
897# If the WARN_IF_DOC_ERROR tag is set to YES, Doxygen will generate warnings for
898# potential errors in the documentation, such as documenting some parameters in
899# a documented function twice, or documenting parameters that don't exist or
900# using markup commands wrongly.
901# The default value is: YES.
902
903WARN_IF_DOC_ERROR = YES
904
905# If WARN_IF_INCOMPLETE_DOC is set to YES, Doxygen will warn about incomplete
906# function parameter documentation. If set to NO, Doxygen will accept that some
907# parameters have no documentation without warning.
908# The default value is: YES.
909
910WARN_IF_INCOMPLETE_DOC = YES
911
912# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
913# are documented, but have no documentation for their parameters or return
914# value. If set to NO, Doxygen will only warn about wrong parameter
915# documentation, but not about the absence of documentation. If EXTRACT_ALL is
916# set to YES then this flag will automatically be disabled. See also
917# WARN_IF_INCOMPLETE_DOC
918# The default value is: NO.
919
920WARN_NO_PARAMDOC = NO
921
922# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about
923# undocumented enumeration values. If set to NO, Doxygen will accept
924# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
925# will automatically be disabled.
926# The default value is: NO.
927
928WARN_IF_UNDOC_ENUM_VAL = NO
929
930# If WARN_LAYOUT_FILE option is set to YES, Doxygen will warn about issues found
931# while parsing the user defined layout file, such as missing or wrong elements.
932# See also LAYOUT_FILE for details. If set to NO, problems with the layout file
933# will be suppressed.
934# The default value is: YES.
935
936WARN_LAYOUT_FILE = YES
937
938# If the WARN_AS_ERROR tag is set to YES then Doxygen will immediately stop when
939# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
940# then Doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
941# at the end of the Doxygen process Doxygen will return with a non-zero status.
942# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves
943# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not
944# write the warning messages in between other messages but write them at the end
945# of a run, in case a WARN_LOGFILE is defined the warning messages will be
946# besides being in the defined file also be shown at the end of a run, unless
947# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
948# the behavior will remain as with the setting FAIL_ON_WARNINGS.
949# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
950# The default value is: NO.
951
952WARN_AS_ERROR = NO
953
954# The WARN_FORMAT tag determines the format of the warning messages that Doxygen
955# can produce. The string should contain the $file, $line, and $text tags, which
956# will be replaced by the file and line number from which the warning originated
957# and the warning text. Optionally the format may contain $version, which will
958# be replaced by the version of the file (if it could be obtained via
959# FILE_VERSION_FILTER)
960# See also: WARN_LINE_FORMAT
961# The default value is: $file:$line: $text.
962
963WARN_FORMAT = "$file:$line: $text"
964
965# In the $text part of the WARN_FORMAT command it is possible that a reference
966# to a more specific place is given. To make it easier to jump to this place
967# (outside of Doxygen) the user can define a custom "cut" / "paste" string.
968# Example:
969# WARN_LINE_FORMAT = "'vi $file +$line'"
970# See also: WARN_FORMAT
971# The default value is: at line $line of file $file.
972
973WARN_LINE_FORMAT = "at line $line of file $file"
974
975# The WARN_LOGFILE tag can be used to specify a file to which warning and error
976# messages should be written. If left blank the output is written to standard
977# error (stderr). In case the file specified cannot be opened for writing the
978# warning and error messages are written to standard error. When as file - is
979# specified the warning and error messages are written to standard output
980# (stdout).
981
982WARN_LOGFILE =
983
984#---------------------------------------------------------------------------
985# Configuration options related to the input files
986#---------------------------------------------------------------------------
987
988# The INPUT tag is used to specify the files and/or directories that contain
989# documented source files. You may enter file names like myfile.cpp or
990# directories like /usr/src/myproject. Separate the files or directories with
991# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
992# Note: If this tag is empty the current directory is searched.
993
994INPUT = src
995
996# This tag can be used to specify the character encoding of the source files
997# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
998# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
999# documentation (see:
1000# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
1001# See also: INPUT_FILE_ENCODING
1002# The default value is: UTF-8.
1003
1004INPUT_ENCODING = UTF-8
1005
1006# This tag can be used to specify the character encoding of the source files
1007# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify
1008# character encoding on a per file pattern basis. Doxygen will compare the file
1009# name with each pattern and apply the encoding instead of the default
1010# INPUT_ENCODING if there is a match. The character encodings are a list of the
1011# form: pattern=encoding (like *.php=ISO-8859-1).
1012# See also: INPUT_ENCODING for further information on supported encodings.
1013
1014INPUT_FILE_ENCODING =
1015
1016# If the value of the INPUT tag contains directories, you can use the
1017# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1018# *.h) to filter out the source-files in the directories.
1019#
1020# Note that for custom extensions or not directly supported extensions you also
1021# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1022# read by Doxygen.
1023#
1024# Note the list of default checked file patterns might differ from the list of
1025# default file extension mappings.
1026#
1027# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
1028# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
1029# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php,
1030# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
1031# provided as Doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
1032# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
1033
1034FILE_PATTERNS = *.c \
1035 *.cc \
1036 *.cxx \
1037 *.cxxm \
1038 *.cpp \
1039 *.cppm \
1040 *.ccm \
1041 *.c++ \
1042 *.c++m \
1043 *.java \
1044 *.ii \
1045 *.ixx \
1046 *.ipp \
1047 *.i++ \
1048 *.inl \
1049 *.idl \
1050 *.ddl \
1051 *.odl \
1052 *.h \
1053 *.hh \
1054 *.hxx \
1055 *.hpp \
1056 *.h++ \
1057 *.l \
1058 *.cs \
1059 *.d \
1060 *.php \
1061 *.php4 \
1062 *.php5 \
1063 *.phtml \
1064 *.inc \
1065 *.m \
1066 *.markdown \
1067 *.md \
1068 *.mm \
1069 *.dox \
1070 *.py \
1071 *.pyw \
1072 *.f90 \
1073 *.f95 \
1074 *.f03 \
1075 *.f08 \
1076 *.f18 \
1077 *.f \
1078 *.for \
1079 *.vhd \
1080 *.vhdl \
1081 *.ucf \
1082 *.qsf \
1083 *.ice
1084
1085# The RECURSIVE tag can be used to specify whether or not subdirectories should
1086# be searched for input files as well.
1087# The default value is: NO.
1088
1089RECURSIVE = YES
1090
1091# The EXCLUDE tag can be used to specify files and/or directories that should be
1092# excluded from the INPUT source files. This way you can easily exclude a
1093# subdirectory from a directory tree whose root is specified with the INPUT tag.
1094#
1095# Note that relative paths are relative to the directory from which Doxygen is
1096# run.
1097
1098EXCLUDE =
1099
1100# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1101# directories that are symbolic links (a Unix file system feature) are excluded
1102# from the input.
1103# The default value is: NO.
1104
1105EXCLUDE_SYMLINKS = NO
1106
1107# If the value of the INPUT tag contains directories, you can use the
1108# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1109# certain files from those directories.
1110#
1111# Note that the wildcards are matched against the file with absolute path, so to
1112# exclude all test directories for example use the pattern */test/*
1113
1114EXCLUDE_PATTERNS =
1115
1116# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1117# (namespaces, classes, functions, etc.) that should be excluded from the
1118# output. The symbol name can be a fully qualified name, a word, or if the
1119# wildcard * is used, a substring. Examples: ANamespace, AClass,
1120# ANamespace::AClass, ANamespace::*Test
1121
1122EXCLUDE_SYMBOLS =
1123
1124# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1125# that contain example code fragments that are included (see the \include
1126# command).
1127
1128EXAMPLE_PATH =
1129
1130# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1131# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1132# *.h) to filter out the source-files in the directories. If left blank all
1133# files are included.
1134
1135EXAMPLE_PATTERNS = *
1136
1137# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1138# searched for input files to be used with the \include or \dontinclude commands
1139# irrespective of the value of the RECURSIVE tag.
1140# The default value is: NO.
1141
1142EXAMPLE_RECURSIVE = NO
1143
1144# The IMAGE_PATH tag can be used to specify one or more files or directories
1145# that contain images that are to be included in the documentation (see the
1146# \image command).
1147
1148IMAGE_PATH =
1149
1150# The INPUT_FILTER tag can be used to specify a program that Doxygen should
1151# invoke to filter for each input file. Doxygen will invoke the filter program
1152# by executing (via popen()) the command:
1153#
1154# <filter> <input-file>
1155#
1156# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1157# name of an input file. Doxygen will then use the output that the filter
1158# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1159# will be ignored.
1160#
1161# Note that the filter must not add or remove lines; it is applied before the
1162# code is scanned, but not when the output code is generated. If lines are added
1163# or removed, the anchors will not be placed correctly.
1164#
1165# Note that Doxygen will use the data processed and written to standard output
1166# for further processing, therefore nothing else, like debug statements or used
1167# commands (so in case of a Windows batch file always use @echo OFF), should be
1168# written to standard output.
1169#
1170# Note that for custom extensions or not directly supported extensions you also
1171# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1172# properly processed by Doxygen.
1173
1174INPUT_FILTER =
1175
1176# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1177# basis. Doxygen will compare the file name with each pattern and apply the
1178# filter if there is a match. The filters are a list of the form: pattern=filter
1179# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1180# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1181# patterns match the file name, INPUT_FILTER is applied.
1182#
1183# Note that for custom extensions or not directly supported extensions you also
1184# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1185# properly processed by Doxygen.
1186
1187FILTER_PATTERNS =
1188
1189# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1190# INPUT_FILTER) will also be used to filter the input files that are used for
1191# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1192# The default value is: NO.
1193
1194FILTER_SOURCE_FILES = NO
1195
1196# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1197# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1198# it is also possible to disable source filtering for a specific pattern using
1199# *.ext= (so without naming a filter).
1200# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1201
1202FILTER_SOURCE_PATTERNS =
1203
1204# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1205# is part of the input, its contents will be placed on the main page
1206# (index.html). This can be useful if you have a project on for instance GitHub
1207# and want to reuse the introduction page also for the Doxygen output.
1208
1209USE_MDFILE_AS_MAINPAGE =
1210
1211# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub-
1212# directories of the project's root, is used as the documentation for that sub-
1213# directory, except when the README.md starts with a \dir, \page or \mainpage
1214# command. If set to NO, the README.md file needs to start with an explicit \dir
1215# command in order to be used as directory documentation.
1216# The default value is: YES.
1217
1218IMPLICIT_DIR_DOCS = YES
1219
1220# The Fortran standard specifies that for fixed formatted Fortran code all
1221# characters from position 72 are to be considered as comment. A common
1222# extension is to allow longer lines before the automatic comment starts. The
1223# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1224# be processed before the automatic comment starts.
1225# Minimum value: 7, maximum value: 10000, default value: 72.
1226
1227FORTRAN_COMMENT_AFTER = 72
1228
1229#---------------------------------------------------------------------------
1230# Configuration options related to source browsing
1231#---------------------------------------------------------------------------
1232
1233# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1234# generated. Documented entities will be cross-referenced with these sources.
1235#
1236# Note: To get rid of all source code in the generated output, make sure that
1237# also VERBATIM_HEADERS is set to NO.
1238# The default value is: NO.
1239
1240SOURCE_BROWSER = NO
1241
1242# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1243# multi-line macros, enums or list initialized variables directly into the
1244# documentation.
1245# The default value is: NO.
1246
1247INLINE_SOURCES = NO
1248
1249# Setting the STRIP_CODE_COMMENTS tag to YES will instruct Doxygen to hide any
1250# special comment blocks from generated source code fragments. Normal C, C++ and
1251# Fortran comments will always remain visible.
1252# The default value is: YES.
1253
1254STRIP_CODE_COMMENTS = YES
1255
1256# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1257# entity all documented functions referencing it will be listed.
1258# The default value is: NO.
1259
1260REFERENCED_BY_RELATION = NO
1261
1262# If the REFERENCES_RELATION tag is set to YES then for each documented function
1263# all documented entities called/used by that function will be listed.
1264# The default value is: NO.
1265
1266REFERENCES_RELATION = NO
1267
1268# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1269# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1270# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1271# link to the documentation.
1272# The default value is: YES.
1273
1274REFERENCES_LINK_SOURCE = YES
1275
1276# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1277# source code will show a tooltip with additional information such as prototype,
1278# brief description and links to the definition and documentation. Since this
1279# will make the HTML file larger and loading of large files a bit slower, you
1280# can opt to disable this feature.
1281# The default value is: YES.
1282# This tag requires that the tag SOURCE_BROWSER is set to YES.
1283
1284SOURCE_TOOLTIPS = YES
1285
1286# If the USE_HTAGS tag is set to YES then the references to source code will
1287# point to the HTML generated by the htags(1) tool instead of Doxygen built-in
1288# source browser. The htags tool is part of GNU's global source tagging system
1289# (see https://www.gnu.org/software/global/global.html). You will need version
1290# 4.8.6 or higher.
1291#
1292# To use it do the following:
1293# - Install the latest version of global
1294# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1295# - Make sure the INPUT points to the root of the source tree
1296# - Run doxygen as normal
1297#
1298# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1299# tools must be available from the command line (i.e. in the search path).
1300#
1301# The result: instead of the source browser generated by Doxygen, the links to
1302# source code will now point to the output of htags.
1303# The default value is: NO.
1304# This tag requires that the tag SOURCE_BROWSER is set to YES.
1305
1306USE_HTAGS = NO
1307
1308# If the VERBATIM_HEADERS tag is set the YES then Doxygen will generate a
1309# verbatim copy of the header file for each class for which an include is
1310# specified. Set to NO to disable this.
1311# See also: Section \class.
1312# The default value is: YES.
1313
1314VERBATIM_HEADERS = YES
1315
1316#---------------------------------------------------------------------------
1317# Configuration options related to the alphabetical class index
1318#---------------------------------------------------------------------------
1319
1320# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1321# compounds will be generated. Enable this if the project contains a lot of
1322# classes, structs, unions or interfaces.
1323# The default value is: YES.
1324
1325ALPHABETICAL_INDEX = YES
1326
1327# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1328# that should be ignored while generating the index headers. The IGNORE_PREFIX
1329# tag works for classes, function and member names. The entity will be placed in
1330# the alphabetical list under the first letter of the entity name that remains
1331# after removing the prefix.
1332# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1333
1334IGNORE_PREFIX =
1335
1336#---------------------------------------------------------------------------
1337# Configuration options related to the HTML output
1338#---------------------------------------------------------------------------
1339
1340# If the GENERATE_HTML tag is set to YES, Doxygen will generate HTML output
1341# The default value is: YES.
1342
1343GENERATE_HTML = YES
1344
1345# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1346# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1347# it.
1348# The default directory is: html.
1349# This tag requires that the tag GENERATE_HTML is set to YES.
1350
1351HTML_OUTPUT = .
1352
1353# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1354# generated HTML page (for example: .htm, .php, .asp).
1355# The default value is: .html.
1356# This tag requires that the tag GENERATE_HTML is set to YES.
1357
1358HTML_FILE_EXTENSION = .html
1359
1360# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1361# each generated HTML page. If the tag is left blank Doxygen will generate a
1362# standard header.
1363#
1364# To get valid HTML the header file that includes any scripts and style sheets
1365# that Doxygen needs, which is dependent on the configuration options used (e.g.
1366# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1367# default header using
1368# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1369# YourConfigFile
1370# and then modify the file new_header.html. See also section "Doxygen usage"
1371# for information on how to generate the default header that Doxygen normally
1372# uses.
1373# Note: The header is subject to change so you typically have to regenerate the
1374# default header when upgrading to a newer version of Doxygen. For a description
1375# of the possible markers and block names see the documentation.
1376# This tag requires that the tag GENERATE_HTML is set to YES.
1377
1378HTML_HEADER =
1379
1380# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1381# generated HTML page. If the tag is left blank Doxygen will generate a standard
1382# footer. See HTML_HEADER for more information on how to generate a default
1383# footer and what special commands can be used inside the footer. See also
1384# section "Doxygen usage" for information on how to generate the default footer
1385# that Doxygen normally uses.
1386# This tag requires that the tag GENERATE_HTML is set to YES.
1387
1388HTML_FOOTER =
1389
1390# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1391# sheet that is used by each HTML page. It can be used to fine-tune the look of
1392# the HTML output. If left blank Doxygen will generate a default style sheet.
1393# See also section "Doxygen usage" for information on how to generate the style
1394# sheet that Doxygen normally uses.
1395# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1396# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1397# obsolete.
1398# This tag requires that the tag GENERATE_HTML is set to YES.
1399
1400HTML_STYLESHEET =
1401
1402# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1403# cascading style sheets that are included after the standard style sheets
1404# created by Doxygen. Using this option one can overrule certain style aspects.
1405# This is preferred over using HTML_STYLESHEET since it does not replace the
1406# standard style sheet and is therefore more robust against future updates.
1407# Doxygen will copy the style sheet files to the output directory.
1408# Note: The order of the extra style sheet files is of importance (e.g. the last
1409# style sheet in the list overrules the setting of the previous ones in the
1410# list).
1411# Note: Since the styling of scrollbars can currently not be overruled in
1412# Webkit/Chromium, the styling will be left out of the default doxygen.css if
1413# one or more extra stylesheets have been specified. So if scrollbar
1414# customization is desired it has to be added explicitly. For an example see the
1415# documentation.
1416# This tag requires that the tag GENERATE_HTML is set to YES.
1417
1418HTML_EXTRA_STYLESHEET =
1419
1420# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1421# other source files which should be copied to the HTML output directory. Note
1422# that these files will be copied to the base HTML output directory. Use the
1423# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1424# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1425# files will be copied as-is; there are no commands or markers available.
1426# This tag requires that the tag GENERATE_HTML is set to YES.
1427
1428HTML_EXTRA_FILES =
1429
1430# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1431# should be rendered with a dark or light theme.
1432# Possible values are: LIGHT always generates light mode output, DARK always
1433# generates dark mode output, AUTO_LIGHT automatically sets the mode according
1434# to the user preference, uses light mode if no preference is set (the default),
1435# AUTO_DARK automatically sets the mode according to the user preference, uses
1436# dark mode if no preference is set and TOGGLE allows a user to switch between
1437# light and dark mode via a button.
1438# The default value is: AUTO_LIGHT.
1439# This tag requires that the tag GENERATE_HTML is set to YES.
1440
1441HTML_COLORSTYLE = AUTO_LIGHT
1442
1443# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1444# will adjust the colors in the style sheet and background images according to
1445# this color. Hue is specified as an angle on a color-wheel, see
1446# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1447# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1448# purple, and 360 is red again.
1449# Minimum value: 0, maximum value: 359, default value: 220.
1450# This tag requires that the tag GENERATE_HTML is set to YES.
1451
1452HTML_COLORSTYLE_HUE = 220
1453
1454# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1455# in the HTML output. For a value of 0 the output will use gray-scales only. A
1456# value of 255 will produce the most vivid colors.
1457# Minimum value: 0, maximum value: 255, default value: 100.
1458# This tag requires that the tag GENERATE_HTML is set to YES.
1459
1460HTML_COLORSTYLE_SAT = 100
1461
1462# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1463# luminance component of the colors in the HTML output. Values below 100
1464# gradually make the output lighter, whereas values above 100 make the output
1465# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1466# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1467# change the gamma.
1468# Minimum value: 40, maximum value: 240, default value: 80.
1469# This tag requires that the tag GENERATE_HTML is set to YES.
1470
1471HTML_COLORSTYLE_GAMMA = 80
1472
1473# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1474# documentation will contain a main index with vertical navigation menus that
1475# are dynamically created via JavaScript. If disabled, the navigation index will
1476# consists of multiple levels of tabs that are statically embedded in every HTML
1477# page. Disable this option to support browsers that do not have JavaScript,
1478# like the Qt help browser.
1479# The default value is: YES.
1480# This tag requires that the tag GENERATE_HTML is set to YES.
1481
1482HTML_DYNAMIC_MENUS = YES
1483
1484# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1485# documentation will contain sections that can be hidden and shown after the
1486# page has loaded.
1487# The default value is: NO.
1488# This tag requires that the tag GENERATE_HTML is set to YES.
1489
1490HTML_DYNAMIC_SECTIONS = YES
1491
1492# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1493# dynamically folded and expanded in the generated HTML source code.
1494# The default value is: YES.
1495# This tag requires that the tag GENERATE_HTML is set to YES.
1496
1497HTML_CODE_FOLDING = YES
1498
1499# If the HTML_COPY_CLIPBOARD tag is set to YES then Doxygen will show an icon in
1500# the top right corner of code and text fragments that allows the user to copy
1501# its content to the clipboard. Note this only works if supported by the browser
1502# and the web page is served via a secure context (see:
1503# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1504# protocol.
1505# The default value is: YES.
1506# This tag requires that the tag GENERATE_HTML is set to YES.
1507
1508HTML_COPY_CLIPBOARD = YES
1509
1510# Doxygen stores a couple of settings persistently in the browser (via e.g.
1511# cookies). By default these settings apply to all HTML pages generated by
1512# Doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1513# the settings under a project specific key, such that the user preferences will
1514# be stored separately.
1515# This tag requires that the tag GENERATE_HTML is set to YES.
1516
1517HTML_PROJECT_COOKIE =
1518
1519# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1520# shown in the various tree structured indices initially; the user can expand
1521# and collapse entries dynamically later on. Doxygen will expand the tree to
1522# such a level that at most the specified number of entries are visible (unless
1523# a fully collapsed tree already exceeds this amount). So setting the number of
1524# entries 1 will produce a full collapsed tree by default. 0 is a special value
1525# representing an infinite number of entries and will result in a full expanded
1526# tree by default.
1527# Minimum value: 0, maximum value: 9999, default value: 100.
1528# This tag requires that the tag GENERATE_HTML is set to YES.
1529
1530HTML_INDEX_NUM_ENTRIES = 100
1531
1532# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1533# generated that can be used as input for Apple's Xcode 3 integrated development
1534# environment (see:
1535# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1536# create a documentation set, Doxygen will generate a Makefile in the HTML
1537# output directory. Running make will produce the docset in that directory and
1538# running make install will install the docset in
1539# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1540# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1541# genXcode/_index.html for more information.
1542# The default value is: NO.
1543# This tag requires that the tag GENERATE_HTML is set to YES.
1544
1545GENERATE_DOCSET = NO
1546
1547# This tag determines the name of the docset feed. A documentation feed provides
1548# an umbrella under which multiple documentation sets from a single provider
1549# (such as a company or product suite) can be grouped.
1550# The default value is: Doxygen generated docs.
1551# This tag requires that the tag GENERATE_DOCSET is set to YES.
1552
1553DOCSET_FEEDNAME = "Doxygen generated docs"
1554
1555# This tag determines the URL of the docset feed. A documentation feed provides
1556# an umbrella under which multiple documentation sets from a single provider
1557# (such as a company or product suite) can be grouped.
1558# This tag requires that the tag GENERATE_DOCSET is set to YES.
1559
1560DOCSET_FEEDURL =
1561
1562# This tag specifies a string that should uniquely identify the documentation
1563# set bundle. This should be a reverse domain-name style string, e.g.
1564# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1565# The default value is: org.doxygen.Project.
1566# This tag requires that the tag GENERATE_DOCSET is set to YES.
1567
1568DOCSET_BUNDLE_ID = org.doxygen.Project
1569
1570# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1571# the documentation publisher. This should be a reverse domain-name style
1572# string, e.g. com.mycompany.MyDocSet.documentation.
1573# The default value is: org.doxygen.Publisher.
1574# This tag requires that the tag GENERATE_DOCSET is set to YES.
1575
1576DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1577
1578# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1579# The default value is: Publisher.
1580# This tag requires that the tag GENERATE_DOCSET is set to YES.
1581
1582DOCSET_PUBLISHER_NAME = Publisher
1583
1584# If the GENERATE_HTMLHELP tag is set to YES then Doxygen generates three
1585# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1586# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1587# on Windows. In the beginning of 2021 Microsoft took the original page, with
1588# a.o. the download links, offline (the HTML help workshop was already many
1589# years in maintenance mode). You can download the HTML help workshop from the
1590# web archives at Installation executable (see:
1591# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1592# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1593#
1594# The HTML Help Workshop contains a compiler that can convert all HTML output
1595# generated by Doxygen into a single compiled HTML file (.chm). Compiled HTML
1596# files are now used as the Windows 98 help format, and will replace the old
1597# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1598# HTML files also contain an index, a table of contents, and you can search for
1599# words in the documentation. The HTML workshop also contains a viewer for
1600# compressed HTML files.
1601# The default value is: NO.
1602# This tag requires that the tag GENERATE_HTML is set to YES.
1603
1604GENERATE_HTMLHELP = NO
1605
1606# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1607# file. You can add a path in front of the file if the result should not be
1608# written to the html output directory.
1609# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1610
1611CHM_FILE =
1612
1613# The HHC_LOCATION tag can be used to specify the location (absolute path
1614# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1615# Doxygen will try to run the HTML help compiler on the generated index.hhp.
1616# The file has to be specified with full path.
1617# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1618
1619HHC_LOCATION =
1620
1621# The GENERATE_CHI flag controls if a separate .chi index file is generated
1622# (YES) or that it should be included in the main .chm file (NO).
1623# The default value is: NO.
1624# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1625
1626GENERATE_CHI = NO
1627
1628# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1629# and project file content.
1630# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1631
1632CHM_INDEX_ENCODING =
1633
1634# The BINARY_TOC flag controls whether a binary table of contents is generated
1635# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1636# enables the Previous and Next buttons.
1637# The default value is: NO.
1638# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1639
1640BINARY_TOC = NO
1641
1642# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1643# the table of contents of the HTML help documentation and to the tree view.
1644# The default value is: NO.
1645# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1646
1647TOC_EXPAND = NO
1648
1649# The SITEMAP_URL tag is used to specify the full URL of the place where the
1650# generated documentation will be placed on the server by the user during the
1651# deployment of the documentation. The generated sitemap is called sitemap.xml
1652# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1653# is specified no sitemap is generated. For information about the sitemap
1654# protocol see https://www.sitemaps.org
1655# This tag requires that the tag GENERATE_HTML is set to YES.
1656
1657SITEMAP_URL =
1658
1659# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1660# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1661# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1662# (.qch) of the generated HTML documentation.
1663# The default value is: NO.
1664# This tag requires that the tag GENERATE_HTML is set to YES.
1665
1666GENERATE_QHP = NO
1667
1668# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1669# the file name of the resulting .qch file. The path specified is relative to
1670# the HTML output folder.
1671# This tag requires that the tag GENERATE_QHP is set to YES.
1672
1673QCH_FILE =
1674
1675# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1676# Project output. For more information please see Qt Help Project / Namespace
1677# (see:
1678# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1679# The default value is: org.doxygen.Project.
1680# This tag requires that the tag GENERATE_QHP is set to YES.
1681
1682QHP_NAMESPACE = org.doxygen.Project
1683
1684# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1685# Help Project output. For more information please see Qt Help Project / Virtual
1686# Folders (see:
1687# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1688# The default value is: doc.
1689# This tag requires that the tag GENERATE_QHP is set to YES.
1690
1691QHP_VIRTUAL_FOLDER = doc
1692
1693# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1694# filter to add. For more information please see Qt Help Project / Custom
1695# Filters (see:
1696# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1697# This tag requires that the tag GENERATE_QHP is set to YES.
1698
1699QHP_CUST_FILTER_NAME =
1700
1701# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1702# custom filter to add. For more information please see Qt Help Project / Custom
1703# Filters (see:
1704# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1705# This tag requires that the tag GENERATE_QHP is set to YES.
1706
1707QHP_CUST_FILTER_ATTRS =
1708
1709# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1710# project's filter section matches. Qt Help Project / Filter Attributes (see:
1711# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1712# This tag requires that the tag GENERATE_QHP is set to YES.
1713
1714QHP_SECT_FILTER_ATTRS =
1715
1716# The QHG_LOCATION tag can be used to specify the location (absolute path
1717# including file name) of Qt's qhelpgenerator. If non-empty Doxygen will try to
1718# run qhelpgenerator on the generated .qhp file.
1719# This tag requires that the tag GENERATE_QHP is set to YES.
1720
1721QHG_LOCATION =
1722
1723# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1724# generated, together with the HTML files, they form an Eclipse help plugin. To
1725# install this plugin and make it available under the help contents menu in
1726# Eclipse, the contents of the directory containing the HTML and XML files needs
1727# to be copied into the plugins directory of eclipse. The name of the directory
1728# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1729# After copying Eclipse needs to be restarted before the help appears.
1730# The default value is: NO.
1731# This tag requires that the tag GENERATE_HTML is set to YES.
1732
1733GENERATE_ECLIPSEHELP = NO
1734
1735# A unique identifier for the Eclipse help plugin. When installing the plugin
1736# the directory name containing the HTML and XML files should also have this
1737# name. Each documentation set should have its own identifier.
1738# The default value is: org.doxygen.Project.
1739# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1740
1741ECLIPSE_DOC_ID = org.doxygen.Project
1742
1743# If you want full control over the layout of the generated HTML pages it might
1744# be necessary to disable the index and replace it with your own. The
1745# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1746# of each HTML page. A value of NO enables the index and the value YES disables
1747# it. Since the tabs in the index contain the same information as the navigation
1748# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1749# The default value is: NO.
1750# This tag requires that the tag GENERATE_HTML is set to YES.
1751
1752DISABLE_INDEX = NO
1753
1754# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1755# structure should be generated to display hierarchical information. If the tag
1756# value is set to YES, a side panel will be generated containing a tree-like
1757# index structure (just like the one that is generated for HTML Help). For this
1758# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1759# (i.e. any modern browser). Windows users are probably better off using the
1760# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1761# further fine tune the look of the index (see "Fine-tuning the output"). As an
1762# example, the default style sheet generated by Doxygen has an example that
1763# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1764# Since the tree basically has more details information than the tab index, you
1765# could consider setting DISABLE_INDEX to YES when enabling this option.
1766# The default value is: YES.
1767# This tag requires that the tag GENERATE_HTML is set to YES.
1768
1769GENERATE_TREEVIEW = YES
1770
1771# When GENERATE_TREEVIEW is set to YES, the PAGE_OUTLINE_PANEL option determines
1772# if an additional navigation panel is shown at the right hand side of the
1773# screen, displaying an outline of the contents of the main page, similar to
1774# e.g. https://developer.android.com/reference If GENERATE_TREEVIEW is set to
1775# NO, this option has no effect.
1776# The default value is: YES.
1777# This tag requires that the tag GENERATE_HTML is set to YES.
1778
1779PAGE_OUTLINE_PANEL = YES
1780
1781# When GENERATE_TREEVIEW is set to YES, the FULL_SIDEBAR option determines if
1782# the side bar is limited to only the treeview area (value NO) or if it should
1783# extend to the full height of the window (value YES). Setting this to YES gives
1784# a layout similar to e.g. https://docs.readthedocs.io with more room for
1785# contents, but less room for the project logo, title, and description. If
1786# GENERATE_TREEVIEW is set to NO, this option has no effect.
1787# The default value is: NO.
1788# This tag requires that the tag GENERATE_HTML is set to YES.
1789
1790FULL_SIDEBAR = YES
1791
1792# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1793# Doxygen will group on one line in the generated HTML documentation.
1794#
1795# Note that a value of 0 will completely suppress the enum values from appearing
1796# in the overview section.
1797# Minimum value: 0, maximum value: 20, default value: 4.
1798# This tag requires that the tag GENERATE_HTML is set to YES.
1799
1800ENUM_VALUES_PER_LINE = 4
1801
1802# When the SHOW_ENUM_VALUES tag is set doxygen will show the specified
1803# enumeration values besides the enumeration mnemonics.
1804# The default value is: NO.
1805
1806SHOW_ENUM_VALUES = NO
1807
1808# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1809# to set the initial width (in pixels) of the frame in which the tree is shown.
1810# Minimum value: 0, maximum value: 1500, default value: 250.
1811# This tag requires that the tag GENERATE_HTML is set to YES.
1812
1813TREEVIEW_WIDTH = 250
1814
1815# If the EXT_LINKS_IN_WINDOW option is set to YES, Doxygen will open links to
1816# external symbols imported via tag files in a separate window.
1817# The default value is: NO.
1818# This tag requires that the tag GENERATE_HTML is set to YES.
1819
1820EXT_LINKS_IN_WINDOW = NO
1821
1822# If the OBFUSCATE_EMAILS tag is set to YES, Doxygen will obfuscate email
1823# addresses.
1824# The default value is: YES.
1825# This tag requires that the tag GENERATE_HTML is set to YES.
1826
1827OBFUSCATE_EMAILS = YES
1828
1829# If the HTML_FORMULA_FORMAT option is set to svg, Doxygen will use the pdf2svg
1830# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1831# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1832# the HTML output. These images will generally look nicer at scaled resolutions.
1833# Possible values are: png (the default) and svg (looks nicer but requires the
1834# pdf2svg or inkscape tool).
1835# The default value is: png.
1836# This tag requires that the tag GENERATE_HTML is set to YES.
1837
1838HTML_FORMULA_FORMAT = png
1839
1840# Use this tag to change the font size of LaTeX formulas included as images in
1841# the HTML documentation. When you change the font size after a successful
1842# Doxygen run you need to manually remove any form_*.png images from the HTML
1843# output directory to force them to be regenerated.
1844# Minimum value: 8, maximum value: 50, default value: 10.
1845# This tag requires that the tag GENERATE_HTML is set to YES.
1846
1847FORMULA_FONTSIZE = 10
1848
1849# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1850# to create new LaTeX commands to be used in formulas as building blocks. See
1851# the section "Including formulas" for details.
1852
1853FORMULA_MACROFILE =
1854
1855# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1856# https://www.mathjax.org) which uses client side JavaScript for the rendering
1857# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1858# installed or if you want to formulas look prettier in the HTML output. When
1859# enabled you may also need to install MathJax separately and configure the path
1860# to it using the MATHJAX_RELPATH option.
1861# The default value is: NO.
1862# This tag requires that the tag GENERATE_HTML is set to YES.
1863
1864USE_MATHJAX = NO
1865
1866# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1867# Note that the different versions of MathJax have different requirements with
1868# regards to the different settings, so it is possible that also other MathJax
1869# settings have to be changed when switching between the different MathJax
1870# versions.
1871# Possible values are: MathJax_2 and MathJax_3.
1872# The default value is: MathJax_2.
1873# This tag requires that the tag USE_MATHJAX is set to YES.
1874
1875MATHJAX_VERSION = MathJax_2
1876
1877# When MathJax is enabled you can set the default output format to be used for
1878# the MathJax output. For more details about the output format see MathJax
1879# version 2 (see:
1880# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1881# (see:
1882# http://docs.mathjax.org/en/latest/web/components/output.html).
1883# Possible values are: HTML-CSS (which is slower, but has the best
1884# compatibility. This is the name for Mathjax version 2, for MathJax version 3
1885# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1886# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1887# is the name for Mathjax version 3, for MathJax version 2 this will be
1888# translated into HTML-CSS) and SVG.
1889# The default value is: HTML-CSS.
1890# This tag requires that the tag USE_MATHJAX is set to YES.
1891
1892MATHJAX_FORMAT = HTML-CSS
1893
1894# When MathJax is enabled you need to specify the location relative to the HTML
1895# output directory using the MATHJAX_RELPATH option. The destination directory
1896# should contain the MathJax.js script. For instance, if the mathjax directory
1897# is located at the same level as the HTML output directory, then
1898# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1899# Content Delivery Network so you can quickly see the result without installing
1900# MathJax. However, it is strongly recommended to install a local copy of
1901# MathJax from https://www.mathjax.org before deployment. The default value is:
1902# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1903# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1904# This tag requires that the tag USE_MATHJAX is set to YES.
1905
1906MATHJAX_RELPATH =
1907
1908# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1909# extension names that should be enabled during MathJax rendering. For example
1910# for MathJax version 2 (see
1911# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1912# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1913# For example for MathJax version 3 (see
1914# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1915# MATHJAX_EXTENSIONS = ams
1916# This tag requires that the tag USE_MATHJAX is set to YES.
1917
1918MATHJAX_EXTENSIONS =
1919
1920# The MATHJAX_CODEFILE tag can be used to specify a file with JavaScript pieces
1921# of code that will be used on startup of the MathJax code. See the MathJax site
1922# (see:
1923# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1924# example see the documentation.
1925# This tag requires that the tag USE_MATHJAX is set to YES.
1926
1927MATHJAX_CODEFILE =
1928
1929# When the SEARCHENGINE tag is enabled Doxygen will generate a search box for
1930# the HTML output. The underlying search engine uses JavaScript and DHTML and
1931# should work on any modern browser. Note that when using HTML help
1932# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1933# there is already a search function so this one should typically be disabled.
1934# For large projects the JavaScript based search engine can be slow, then
1935# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1936# search using the keyboard; to jump to the search box use <access key> + S
1937# (what the <access key> is depends on the OS and browser, but it is typically
1938# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1939# key> to jump into the search results window, the results can be navigated
1940# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1941# the search. The filter options can be selected when the cursor is inside the
1942# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1943# to select a filter and <Enter> or <escape> to activate or cancel the filter
1944# option.
1945# The default value is: YES.
1946# This tag requires that the tag GENERATE_HTML is set to YES.
1947
1948SEARCHENGINE = YES
1949
1950# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1951# implemented using a web server instead of a web client using JavaScript. There
1952# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1953# setting. When disabled, Doxygen will generate a PHP script for searching and
1954# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1955# and searching needs to be provided by external tools. See the section
1956# "External Indexing and Searching" for details.
1957# The default value is: NO.
1958# This tag requires that the tag SEARCHENGINE is set to YES.
1959
1960SERVER_BASED_SEARCH = NO
1961
1962# When EXTERNAL_SEARCH tag is enabled Doxygen will no longer generate the PHP
1963# script for searching. Instead the search results are written to an XML file
1964# which needs to be processed by an external indexer. Doxygen will invoke an
1965# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1966# search results.
1967#
1968# Doxygen ships with an example indexer (doxyindexer) and search engine
1969# (doxysearch.cgi) which are based on the open source search engine library
1970# Xapian (see:
1971# https://xapian.org/).
1972#
1973# See the section "External Indexing and Searching" for details.
1974# The default value is: NO.
1975# This tag requires that the tag SEARCHENGINE is set to YES.
1976
1977EXTERNAL_SEARCH = NO
1978
1979# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1980# which will return the search results when EXTERNAL_SEARCH is enabled.
1981#
1982# Doxygen ships with an example indexer (doxyindexer) and search engine
1983# (doxysearch.cgi) which are based on the open source search engine library
1984# Xapian (see:
1985# https://xapian.org/). See the section "External Indexing and Searching" for
1986# details.
1987# This tag requires that the tag SEARCHENGINE is set to YES.
1988
1989SEARCHENGINE_URL =
1990
1991# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1992# search data is written to a file for indexing by an external tool. With the
1993# SEARCHDATA_FILE tag the name of this file can be specified.
1994# The default file is: searchdata.xml.
1995# This tag requires that the tag SEARCHENGINE is set to YES.
1996
1997SEARCHDATA_FILE = searchdata.xml
1998
1999# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
2000# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
2001# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
2002# projects and redirect the results back to the right project.
2003# This tag requires that the tag SEARCHENGINE is set to YES.
2004
2005EXTERNAL_SEARCH_ID =
2006
2007# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through Doxygen
2008# projects other than the one defined by this configuration file, but that are
2009# all added to the same external search index. Each project needs to have a
2010# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
2011# to a relative location where the documentation can be found. The format is:
2012# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
2013# This tag requires that the tag SEARCHENGINE is set to YES.
2014
2015EXTRA_SEARCH_MAPPINGS =
2016
2017#---------------------------------------------------------------------------
2018# Configuration options related to the LaTeX output
2019#---------------------------------------------------------------------------
2020
2021# If the GENERATE_LATEX tag is set to YES, Doxygen will generate LaTeX output.
2022# The default value is: YES.
2023
2024GENERATE_LATEX = NO
2025
2026# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
2027# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2028# it.
2029# The default directory is: latex.
2030# This tag requires that the tag GENERATE_LATEX is set to YES.
2031
2032LATEX_OUTPUT = latex
2033
2034# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
2035# invoked.
2036#
2037# Note that when not enabling USE_PDFLATEX the default is latex when enabling
2038# USE_PDFLATEX the default is pdflatex and when in the later case latex is
2039# chosen this is overwritten by pdflatex. For specific output languages the
2040# default can have been set differently, this depends on the implementation of
2041# the output language.
2042# This tag requires that the tag GENERATE_LATEX is set to YES.
2043
2044LATEX_CMD_NAME =
2045
2046# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
2047# index for LaTeX.
2048# Note: This tag is used in the Makefile / make.bat.
2049# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
2050# (.tex).
2051# The default file is: makeindex.
2052# This tag requires that the tag GENERATE_LATEX is set to YES.
2053
2054MAKEINDEX_CMD_NAME = makeindex
2055
2056# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2057# generate index for LaTeX. In case there is no backslash (\) as first character
2058# it will be automatically added in the LaTeX code.
2059# Note: This tag is used in the generated output file (.tex).
2060# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2061# The default value is: makeindex.
2062# This tag requires that the tag GENERATE_LATEX is set to YES.
2063
2064LATEX_MAKEINDEX_CMD = makeindex
2065
2066# If the COMPACT_LATEX tag is set to YES, Doxygen generates more compact LaTeX
2067# documents. This may be useful for small projects and may help to save some
2068# trees in general.
2069# The default value is: NO.
2070# This tag requires that the tag GENERATE_LATEX is set to YES.
2071
2072COMPACT_LATEX = NO
2073
2074# The PAPER_TYPE tag can be used to set the paper type that is used by the
2075# printer.
2076# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
2077# 14 inches) and executive (7.25 x 10.5 inches).
2078# The default value is: a4.
2079# This tag requires that the tag GENERATE_LATEX is set to YES.
2080
2081PAPER_TYPE = a4
2082
2083# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2084# that should be included in the LaTeX output. The package can be specified just
2085# by its name or with the correct syntax as to be used with the LaTeX
2086# \usepackage command. To get the times font for instance you can specify :
2087# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
2088# To use the option intlimits with the amsmath package you can specify:
2089# EXTRA_PACKAGES=[intlimits]{amsmath}
2090# If left blank no extra packages will be included.
2091# This tag requires that the tag GENERATE_LATEX is set to YES.
2092
2093EXTRA_PACKAGES =
2094
2095# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2096# the generated LaTeX document. The header should contain everything until the
2097# first chapter. If it is left blank Doxygen will generate a standard header. It
2098# is highly recommended to start with a default header using
2099# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2100# and then modify the file new_header.tex. See also section "Doxygen usage" for
2101# information on how to generate the default header that Doxygen normally uses.
2102#
2103# Note: Only use a user-defined header if you know what you are doing!
2104# Note: The header is subject to change so you typically have to regenerate the
2105# default header when upgrading to a newer version of Doxygen. The following
2106# commands have a special meaning inside the header (and footer): For a
2107# description of the possible markers and block names see the documentation.
2108# This tag requires that the tag GENERATE_LATEX is set to YES.
2109
2110LATEX_HEADER =
2111
2112# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2113# the generated LaTeX document. The footer should contain everything after the
2114# last chapter. If it is left blank Doxygen will generate a standard footer. See
2115# LATEX_HEADER for more information on how to generate a default footer and what
2116# special commands can be used inside the footer. See also section "Doxygen
2117# usage" for information on how to generate the default footer that Doxygen
2118# normally uses. Note: Only use a user-defined footer if you know what you are
2119# doing!
2120# This tag requires that the tag GENERATE_LATEX is set to YES.
2121
2122LATEX_FOOTER =
2123
2124# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2125# LaTeX style sheets that are included after the standard style sheets created
2126# by Doxygen. Using this option one can overrule certain style aspects. Doxygen
2127# will copy the style sheet files to the output directory.
2128# Note: The order of the extra style sheet files is of importance (e.g. the last
2129# style sheet in the list overrules the setting of the previous ones in the
2130# list).
2131# This tag requires that the tag GENERATE_LATEX is set to YES.
2132
2133LATEX_EXTRA_STYLESHEET =
2134
2135# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2136# other source files which should be copied to the LATEX_OUTPUT output
2137# directory. Note that the files will be copied as-is; there are no commands or
2138# markers available.
2139# This tag requires that the tag GENERATE_LATEX is set to YES.
2140
2141LATEX_EXTRA_FILES =
2142
2143# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2144# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2145# contain links (just like the HTML output) instead of page references. This
2146# makes the output suitable for online browsing using a PDF viewer.
2147# The default value is: YES.
2148# This tag requires that the tag GENERATE_LATEX is set to YES.
2149
2150PDF_HYPERLINKS = YES
2151
2152# If the USE_PDFLATEX tag is set to YES, Doxygen will use the engine as
2153# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2154# files. Set this option to YES, to get a higher quality PDF documentation.
2155#
2156# See also section LATEX_CMD_NAME for selecting the engine.
2157# The default value is: YES.
2158# This tag requires that the tag GENERATE_LATEX is set to YES.
2159
2160USE_PDFLATEX = YES
2161
2162# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
2163# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2164# mode nothing is printed on the terminal, errors are scrolled as if <return> is
2165# hit at every error; missing files that TeX tries to input or request from
2166# keyboard input (\read on a not open input stream) cause the job to abort,
2167# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2168# but there is no possibility of user interaction just like in batch mode,
2169# SCROLL In scroll mode, TeX will stop only for missing files to input or if
2170# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2171# each error, asking for user intervention.
2172# The default value is: NO.
2173# This tag requires that the tag GENERATE_LATEX is set to YES.
2174
2175LATEX_BATCHMODE = NO
2176
2177# If the LATEX_HIDE_INDICES tag is set to YES then Doxygen will not include the
2178# index chapters (such as File Index, Compound Index, etc.) in the output.
2179# The default value is: NO.
2180# This tag requires that the tag GENERATE_LATEX is set to YES.
2181
2182LATEX_HIDE_INDICES = NO
2183
2184# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2185# bibliography, e.g. plainnat, or ieeetr. See
2186# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2187# The default value is: plainnat.
2188# This tag requires that the tag GENERATE_LATEX is set to YES.
2189
2190LATEX_BIB_STYLE = plainnat
2191
2192# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2193# path from which the emoji images will be read. If a relative path is entered,
2194# it will be relative to the LATEX_OUTPUT directory. If left blank the
2195# LATEX_OUTPUT directory will be used.
2196# This tag requires that the tag GENERATE_LATEX is set to YES.
2197
2198LATEX_EMOJI_DIRECTORY =
2199
2200#---------------------------------------------------------------------------
2201# Configuration options related to the RTF output
2202#---------------------------------------------------------------------------
2203
2204# If the GENERATE_RTF tag is set to YES, Doxygen will generate RTF output. The
2205# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2206# readers/editors.
2207# The default value is: NO.
2208
2209GENERATE_RTF = NO
2210
2211# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2212# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2213# it.
2214# The default directory is: rtf.
2215# This tag requires that the tag GENERATE_RTF is set to YES.
2216
2217RTF_OUTPUT = rtf
2218
2219# If the COMPACT_RTF tag is set to YES, Doxygen generates more compact RTF
2220# documents. This may be useful for small projects and may help to save some
2221# trees in general.
2222# The default value is: NO.
2223# This tag requires that the tag GENERATE_RTF is set to YES.
2224
2225COMPACT_RTF = NO
2226
2227# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2228# contain hyperlink fields. The RTF file will contain links (just like the HTML
2229# output) instead of page references. This makes the output suitable for online
2230# browsing using Word or some other Word compatible readers that support those
2231# fields.
2232#
2233# Note: WordPad (write) and others do not support links.
2234# The default value is: NO.
2235# This tag requires that the tag GENERATE_RTF is set to YES.
2236
2237RTF_HYPERLINKS = NO
2238
2239# Load stylesheet definitions from file. Syntax is similar to Doxygen's
2240# configuration file, i.e. a series of assignments. You only have to provide
2241# replacements, missing definitions are set to their default value.
2242#
2243# See also section "Doxygen usage" for information on how to generate the
2244# default style sheet that Doxygen normally uses.
2245# This tag requires that the tag GENERATE_RTF is set to YES.
2246
2247RTF_STYLESHEET_FILE =
2248
2249# Set optional variables used in the generation of an RTF document. Syntax is
2250# similar to Doxygen's configuration file. A template extensions file can be
2251# generated using doxygen -e rtf extensionFile.
2252# This tag requires that the tag GENERATE_RTF is set to YES.
2253
2254RTF_EXTENSIONS_FILE =
2255
2256# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or
2257# other source files which should be copied to the RTF_OUTPUT output directory.
2258# Note that the files will be copied as-is; there are no commands or markers
2259# available.
2260# This tag requires that the tag GENERATE_RTF is set to YES.
2261
2262RTF_EXTRA_FILES =
2263
2264#---------------------------------------------------------------------------
2265# Configuration options related to the man page output
2266#---------------------------------------------------------------------------
2267
2268# If the GENERATE_MAN tag is set to YES, Doxygen will generate man pages for
2269# classes and files.
2270# The default value is: NO.
2271
2272GENERATE_MAN = NO
2273
2274# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2275# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2276# it. A directory man3 will be created inside the directory specified by
2277# MAN_OUTPUT.
2278# The default directory is: man.
2279# This tag requires that the tag GENERATE_MAN is set to YES.
2280
2281MAN_OUTPUT = man
2282
2283# The MAN_EXTENSION tag determines the extension that is added to the generated
2284# man pages. In case the manual section does not start with a number, the number
2285# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2286# optional.
2287# The default value is: .3.
2288# This tag requires that the tag GENERATE_MAN is set to YES.
2289
2290MAN_EXTENSION = .3
2291
2292# The MAN_SUBDIR tag determines the name of the directory created within
2293# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2294# MAN_EXTENSION with the initial . removed.
2295# This tag requires that the tag GENERATE_MAN is set to YES.
2296
2297MAN_SUBDIR =
2298
2299# If the MAN_LINKS tag is set to YES and Doxygen generates man output, then it
2300# will generate one additional man file for each entity documented in the real
2301# man page(s). These additional files only source the real man page, but without
2302# them the man command would be unable to find the correct page.
2303# The default value is: NO.
2304# This tag requires that the tag GENERATE_MAN is set to YES.
2305
2306MAN_LINKS = NO
2307
2308#---------------------------------------------------------------------------
2309# Configuration options related to the XML output
2310#---------------------------------------------------------------------------
2311
2312# If the GENERATE_XML tag is set to YES, Doxygen will generate an XML file that
2313# captures the structure of the code including all documentation.
2314# The default value is: NO.
2315
2316GENERATE_XML = NO
2317
2318# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2319# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2320# it.
2321# The default directory is: xml.
2322# This tag requires that the tag GENERATE_XML is set to YES.
2323
2324XML_OUTPUT = xml
2325
2326# If the XML_PROGRAMLISTING tag is set to YES, Doxygen will dump the program
2327# listings (including syntax highlighting and cross-referencing information) to
2328# the XML output. Note that enabling this will significantly increase the size
2329# of the XML output.
2330# The default value is: YES.
2331# This tag requires that the tag GENERATE_XML is set to YES.
2332
2333XML_PROGRAMLISTING = YES
2334
2335# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, Doxygen will include
2336# namespace members in file scope as well, matching the HTML output.
2337# The default value is: NO.
2338# This tag requires that the tag GENERATE_XML is set to YES.
2339
2340XML_NS_MEMB_FILE_SCOPE = NO
2341
2342#---------------------------------------------------------------------------
2343# Configuration options related to the DOCBOOK output
2344#---------------------------------------------------------------------------
2345
2346# If the GENERATE_DOCBOOK tag is set to YES, Doxygen will generate Docbook files
2347# that can be used to generate PDF.
2348# The default value is: NO.
2349
2350GENERATE_DOCBOOK = NO
2351
2352# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2353# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2354# front of it.
2355# The default directory is: docbook.
2356# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2357
2358DOCBOOK_OUTPUT = docbook
2359
2360#---------------------------------------------------------------------------
2361# Configuration options for the AutoGen Definitions output
2362#---------------------------------------------------------------------------
2363
2364# If the GENERATE_AUTOGEN_DEF tag is set to YES, Doxygen will generate an
2365# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
2366# the structure of the code including all documentation. Note that this feature
2367# is still experimental and incomplete at the moment.
2368# The default value is: NO.
2369
2370GENERATE_AUTOGEN_DEF = NO
2371
2372#---------------------------------------------------------------------------
2373# Configuration options related to Sqlite3 output
2374#---------------------------------------------------------------------------
2375
2376# If the GENERATE_SQLITE3 tag is set to YES Doxygen will generate a Sqlite3
2377# database with symbols found by Doxygen stored in tables.
2378# The default value is: NO.
2379
2380GENERATE_SQLITE3 = NO
2381
2382# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2383# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2384# in front of it.
2385# The default directory is: sqlite3.
2386# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2387
2388SQLITE3_OUTPUT = sqlite3
2389
2390# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
2391# database file will be recreated with each Doxygen run. If set to NO, Doxygen
2392# will warn if a database file is already found and not modify it.
2393# The default value is: YES.
2394# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2395
2396SQLITE3_RECREATE_DB = YES
2397
2398#---------------------------------------------------------------------------
2399# Configuration options related to the Perl module output
2400#---------------------------------------------------------------------------
2401
2402# If the GENERATE_PERLMOD tag is set to YES, Doxygen will generate a Perl module
2403# file that captures the structure of the code including all documentation.
2404#
2405# Note that this feature is still experimental and incomplete at the moment.
2406# The default value is: NO.
2407
2408GENERATE_PERLMOD = NO
2409
2410# If the PERLMOD_LATEX tag is set to YES, Doxygen will generate the necessary
2411# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2412# output from the Perl module output.
2413# The default value is: NO.
2414# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2415
2416PERLMOD_LATEX = NO
2417
2418# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2419# formatted so it can be parsed by a human reader. This is useful if you want to
2420# understand what is going on. On the other hand, if this tag is set to NO, the
2421# size of the Perl module output will be much smaller and Perl will parse it
2422# just the same.
2423# The default value is: YES.
2424# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2425
2426PERLMOD_PRETTY = YES
2427
2428# The names of the make variables in the generated doxyrules.make file are
2429# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2430# so different doxyrules.make files included by the same Makefile don't
2431# overwrite each other's variables.
2432# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2433
2434PERLMOD_MAKEVAR_PREFIX =
2435
2436#---------------------------------------------------------------------------
2437# Configuration options related to the preprocessor
2438#---------------------------------------------------------------------------
2439
2440# If the ENABLE_PREPROCESSING tag is set to YES, Doxygen will evaluate all
2441# C-preprocessor directives found in the sources and include files.
2442# The default value is: YES.
2443
2444ENABLE_PREPROCESSING = YES
2445
2446# If the MACRO_EXPANSION tag is set to YES, Doxygen will expand all macro names
2447# in the source code. If set to NO, only conditional compilation will be
2448# performed. Macro expansion can be done in a controlled way by setting
2449# EXPAND_ONLY_PREDEF to YES.
2450# The default value is: NO.
2451# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2452
2453MACRO_EXPANSION = NO
2454
2455# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2456# the macro expansion is limited to the macros specified with the PREDEFINED and
2457# EXPAND_AS_DEFINED tags.
2458# The default value is: NO.
2459# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2460
2461EXPAND_ONLY_PREDEF = NO
2462
2463# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2464# INCLUDE_PATH will be searched if a #include is found.
2465# The default value is: YES.
2466# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2467
2468SEARCH_INCLUDES = YES
2469
2470# The INCLUDE_PATH tag can be used to specify one or more directories that
2471# contain include files that are not input files but should be processed by the
2472# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2473# RECURSIVE has no effect here.
2474# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2475
2476INCLUDE_PATH =
2477
2478# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2479# patterns (like *.h and *.hpp) to filter out the header-files in the
2480# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2481# used.
2482# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2483
2484INCLUDE_FILE_PATTERNS =
2485
2486# The PREDEFINED tag can be used to specify one or more macro names that are
2487# defined before the preprocessor is started (similar to the -D option of e.g.
2488# gcc). The argument of the tag is a list of macros of the form: name or
2489# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2490# is assumed. To prevent a macro definition from being undefined via #undef or
2491# recursively expanded use the := operator instead of the = operator.
2492# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2493
2494PREDEFINED =
2495
2496# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2497# tag can be used to specify a list of macro names that should be expanded. The
2498# macro definition that is found in the sources will be used. Use the PREDEFINED
2499# tag if you want to use a different macro definition that overrules the
2500# definition found in the source code.
2501# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2502
2503EXPAND_AS_DEFINED =
2504
2505# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
2506# remove all references to function-like macros that are alone on a line, have
2507# an all uppercase name, and do not end with a semicolon. Such function macros
2508# are typically used for boiler-plate code, and will confuse the parser if not
2509# removed.
2510# The default value is: YES.
2511# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2512
2513SKIP_FUNCTION_MACROS = YES
2514
2515#---------------------------------------------------------------------------
2516# Configuration options related to external references
2517#---------------------------------------------------------------------------
2518
2519# The TAGFILES tag can be used to specify one or more tag files. For each tag
2520# file the location of the external documentation should be added. The format of
2521# a tag file without this location is as follows:
2522# TAGFILES = file1 file2 ...
2523# Adding location for the tag files is done as follows:
2524# TAGFILES = file1=loc1 "file2 = loc2" ...
2525# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2526# section "Linking to external documentation" for more information about the use
2527# of tag files.
2528# Note: Each tag file must have a unique name (where the name does NOT include
2529# the path). If a tag file is not located in the directory in which Doxygen is
2530# run, you must also specify the path to the tagfile here.
2531
2532TAGFILES =
2533
2534# When a file name is specified after GENERATE_TAGFILE, Doxygen will create a
2535# tag file that is based on the input files it reads. See section "Linking to
2536# external documentation" for more information about the usage of tag files.
2537
2538GENERATE_TAGFILE =
2539
2540# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2541# will be listed in the class and namespace index. If set to NO, only the
2542# inherited external classes will be listed.
2543# The default value is: NO.
2544
2545ALLEXTERNALS = NO
2546
2547# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2548# in the topic index. If set to NO, only the current project's groups will be
2549# listed.
2550# The default value is: YES.
2551
2552EXTERNAL_GROUPS = YES
2553
2554# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2555# the related pages index. If set to NO, only the current project's pages will
2556# be listed.
2557# The default value is: YES.
2558
2559EXTERNAL_PAGES = YES
2560
2561#---------------------------------------------------------------------------
2562# Configuration options related to diagram generator tools
2563#---------------------------------------------------------------------------
2564
2565# If set to YES the inheritance and collaboration graphs will hide inheritance
2566# and usage relations if the target is undocumented or is not a class.
2567# The default value is: YES.
2568
2569HIDE_UNDOC_RELATIONS = YES
2570
2571# If you set the HAVE_DOT tag to YES then Doxygen will assume the dot tool is
2572# available from the path. This tool is part of Graphviz (see:
2573# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2574# Bell Labs. The other options in this section have no effect if this option is
2575# set to NO
2576# The default value is: NO.
2577
2578HAVE_DOT = NO
2579
2580# The DOT_NUM_THREADS specifies the number of dot invocations Doxygen is allowed
2581# to run in parallel. When set to 0 Doxygen will base this on the number of
2582# processors available in the system. You can set it explicitly to a value
2583# larger than 0 to get control over the balance between CPU load and processing
2584# speed.
2585# Minimum value: 0, maximum value: 32, default value: 0.
2586# This tag requires that the tag HAVE_DOT is set to YES.
2587
2588DOT_NUM_THREADS = 0
2589
2590# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2591# subgraphs. When you want a differently looking font in the dot files that
2592# Doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2593# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2594# Edge and Graph Attributes specification</a> You need to make sure dot is able
2595# to find the font, which can be done by putting it in a standard location or by
2596# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2597# directory containing the font. Default graphviz fontsize is 14.
2598# The default value is: fontname=Helvetica,fontsize=10.
2599# This tag requires that the tag HAVE_DOT is set to YES.
2600
2601DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2602
2603# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2604# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2605# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2606# arrows shapes.</a>
2607# The default value is: labelfontname=Helvetica,labelfontsize=10.
2608# This tag requires that the tag HAVE_DOT is set to YES.
2609
2610DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2611
2612# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2613# around nodes set 'shape=plain' or 'shape=plaintext' <a
2614# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2615# The default value is: shape=box,height=0.2,width=0.4.
2616# This tag requires that the tag HAVE_DOT is set to YES.
2617
2618DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2619
2620# You can set the path where dot can find font specified with fontname in
2621# DOT_COMMON_ATTR and others dot attributes.
2622# This tag requires that the tag HAVE_DOT is set to YES.
2623
2624DOT_FONTPATH =
2625
2626# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then Doxygen will
2627# generate a graph for each documented class showing the direct and indirect
2628# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2629# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2630# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2631# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2632# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2633# relations will be shown as texts / links. Explicit enabling an inheritance
2634# graph or choosing a different representation for an inheritance graph of a
2635# specific class, can be accomplished by means of the command \inheritancegraph.
2636# Disabling an inheritance graph can be accomplished by means of the command
2637# \hideinheritancegraph.
2638# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
2639# The default value is: YES.
2640
2641CLASS_GRAPH = YES
2642
2643# If the COLLABORATION_GRAPH tag is set to YES then Doxygen will generate a
2644# graph for each documented class showing the direct and indirect implementation
2645# dependencies (inheritance, containment, and class references variables) of the
2646# class with other documented classes. Explicit enabling a collaboration graph,
2647# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2648# command \collaborationgraph. Disabling a collaboration graph can be
2649# accomplished by means of the command \hidecollaborationgraph.
2650# The default value is: YES.
2651# This tag requires that the tag HAVE_DOT is set to YES.
2652
2653COLLABORATION_GRAPH = YES
2654
2655# If the GROUP_GRAPHS tag is set to YES then Doxygen will generate a graph for
2656# groups, showing the direct groups dependencies. Explicit enabling a group
2657# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2658# of the command \groupgraph. Disabling a directory graph can be accomplished by
2659# means of the command \hidegroupgraph. See also the chapter Grouping in the
2660# manual.
2661# The default value is: YES.
2662# This tag requires that the tag HAVE_DOT is set to YES.
2663
2664GROUP_GRAPHS = YES
2665
2666# If the UML_LOOK tag is set to YES, Doxygen will generate inheritance and
2667# collaboration diagrams in a style similar to the OMG's Unified Modeling
2668# Language.
2669# The default value is: NO.
2670# This tag requires that the tag HAVE_DOT is set to YES.
2671
2672UML_LOOK = NO
2673
2674# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2675# class node. If there are many fields or methods and many nodes the graph may
2676# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2677# number of items for each type to make the size more manageable. Set this to 0
2678# for no limit. Note that the threshold may be exceeded by 50% before the limit
2679# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2680# but if the number exceeds 15, the total amount of fields shown is limited to
2681# 10.
2682# Minimum value: 0, maximum value: 100, default value: 10.
2683# This tag requires that the tag UML_LOOK is set to YES.
2684
2685UML_LIMIT_NUM_FIELDS = 10
2686
2687# If the UML_LOOK tag is enabled, field labels are shown along the edge between
2688# two class nodes. If there are many fields and many nodes the graph may become
2689# too cluttered. The UML_MAX_EDGE_LABELS threshold limits the number of items to
2690# make the size more manageable. Set this to 0 for no limit.
2691# Minimum value: 0, maximum value: 100, default value: 10.
2692# This tag requires that the tag UML_LOOK is set to YES.
2693
2694UML_MAX_EDGE_LABELS = 10
2695
2696# If the DOT_UML_DETAILS tag is set to NO, Doxygen will show attributes and
2697# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2698# tag is set to YES, Doxygen will add type and arguments for attributes and
2699# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, Doxygen
2700# will not generate fields with class member information in the UML graphs. The
2701# class diagrams will look similar to the default class diagrams but using UML
2702# notation for the relationships.
2703# Possible values are: NO, YES and NONE.
2704# The default value is: NO.
2705# This tag requires that the tag UML_LOOK is set to YES.
2706
2707DOT_UML_DETAILS = NO
2708
2709# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2710# to display on a single line. If the actual line length exceeds this threshold
2711# significantly it will be wrapped across multiple lines. Some heuristics are
2712# applied to avoid ugly line breaks.
2713# Minimum value: 0, maximum value: 1000, default value: 17.
2714# This tag requires that the tag HAVE_DOT is set to YES.
2715
2716DOT_WRAP_THRESHOLD = 17
2717
2718# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2719# collaboration graphs will show the relations between templates and their
2720# instances.
2721# The default value is: NO.
2722# This tag requires that the tag HAVE_DOT is set to YES.
2723
2724TEMPLATE_RELATIONS = NO
2725
2726# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2727# YES then Doxygen will generate a graph for each documented file showing the
2728# direct and indirect include dependencies of the file with other documented
2729# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
2730# can be accomplished by means of the command \includegraph. Disabling an
2731# include graph can be accomplished by means of the command \hideincludegraph.
2732# The default value is: YES.
2733# This tag requires that the tag HAVE_DOT is set to YES.
2734
2735INCLUDE_GRAPH = YES
2736
2737# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2738# set to YES then Doxygen will generate a graph for each documented file showing
2739# the direct and indirect include dependencies of the file with other documented
2740# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2741# to NO, can be accomplished by means of the command \includedbygraph. Disabling
2742# an included by graph can be accomplished by means of the command
2743# \hideincludedbygraph.
2744# The default value is: YES.
2745# This tag requires that the tag HAVE_DOT is set to YES.
2746
2747INCLUDED_BY_GRAPH = YES
2748
2749# If the CALL_GRAPH tag is set to YES then Doxygen will generate a call
2750# dependency graph for every global function or class method.
2751#
2752# Note that enabling this option will significantly increase the time of a run.
2753# So in most cases it will be better to enable call graphs for selected
2754# functions only using the \callgraph command. Disabling a call graph can be
2755# accomplished by means of the command \hidecallgraph.
2756# The default value is: NO.
2757# This tag requires that the tag HAVE_DOT is set to YES.
2758
2759CALL_GRAPH = NO
2760
2761# If the CALLER_GRAPH tag is set to YES then Doxygen will generate a caller
2762# dependency graph for every global function or class method.
2763#
2764# Note that enabling this option will significantly increase the time of a run.
2765# So in most cases it will be better to enable caller graphs for selected
2766# functions only using the \callergraph command. Disabling a caller graph can be
2767# accomplished by means of the command \hidecallergraph.
2768# The default value is: NO.
2769# This tag requires that the tag HAVE_DOT is set to YES.
2770
2771CALLER_GRAPH = NO
2772
2773# If the GRAPHICAL_HIERARCHY tag is set to YES then Doxygen will graphical
2774# hierarchy of all classes instead of a textual one.
2775# The default value is: YES.
2776# This tag requires that the tag HAVE_DOT is set to YES.
2777
2778GRAPHICAL_HIERARCHY = YES
2779
2780# If the DIRECTORY_GRAPH tag is set to YES then Doxygen will show the
2781# dependencies a directory has on other directories in a graphical way. The
2782# dependency relations are determined by the #include relations between the
2783# files in the directories. Explicit enabling a directory graph, when
2784# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2785# \directorygraph. Disabling a directory graph can be accomplished by means of
2786# the command \hidedirectorygraph.
2787# The default value is: YES.
2788# This tag requires that the tag HAVE_DOT is set to YES.
2789
2790DIRECTORY_GRAPH = YES
2791
2792# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2793# of child directories generated in directory dependency graphs by dot.
2794# Minimum value: 1, maximum value: 25, default value: 1.
2795# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2796
2797DIR_GRAPH_MAX_DEPTH = 1
2798
2799# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2800# generated by dot. For an explanation of the image formats see the section
2801# output formats in the documentation of the dot tool (Graphviz (see:
2802# https://www.graphviz.org/)).
2803#
2804# Note the formats svg:cairo and svg:cairo:cairo cannot be used in combination
2805# with INTERACTIVE_SVG (the INTERACTIVE_SVG will be set to NO).
2806# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2807# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus,
2808# png:gdiplus:gdiplus, svg:cairo, svg:cairo:cairo, svg:svg, svg:svg:core,
2809# gif:cairo, gif:cairo:gd, gif:cairo:gdiplus, gif:gdiplus, gif:gdiplus:gdiplus,
2810# gif:gd, gif:gd:gd, jpg:cairo, jpg:cairo:gd, jpg:cairo:gdiplus, jpg:gd,
2811# jpg:gd:gd, jpg:gdiplus and jpg:gdiplus:gdiplus.
2812# The default value is: png.
2813# This tag requires that the tag HAVE_DOT is set to YES.
2814
2815DOT_IMAGE_FORMAT = png
2816
2817# If DOT_IMAGE_FORMAT is set to svg or svg:svg or svg:svg:core, then this option
2818# can be set to YES to enable generation of interactive SVG images that allow
2819# zooming and panning.
2820#
2821# Note that this requires a modern browser other than Internet Explorer. Tested
2822# and working are Firefox, Chrome, Safari, and Opera.
2823#
2824# Note This option will be automatically disabled when DOT_IMAGE_FORMAT is set
2825# to svg:cairo or svg:cairo:cairo.
2826# The default value is: NO.
2827# This tag requires that the tag HAVE_DOT is set to YES.
2828
2829INTERACTIVE_SVG = NO
2830
2831# The DOT_PATH tag can be used to specify the path where the dot tool can be
2832# found. If left blank, it is assumed the dot tool can be found in the path.
2833# This tag requires that the tag HAVE_DOT is set to YES.
2834
2835DOT_PATH =
2836
2837# The DOTFILE_DIRS tag can be used to specify one or more directories that
2838# contain dot files that are included in the documentation (see the \dotfile
2839# command).
2840# This tag requires that the tag HAVE_DOT is set to YES.
2841
2842DOTFILE_DIRS =
2843
2844# You can include diagrams made with dia in Doxygen documentation. Doxygen will
2845# then run dia to produce the diagram and insert it in the documentation. The
2846# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2847# If left empty dia is assumed to be found in the default search path.
2848
2849DIA_PATH =
2850
2851# The DIAFILE_DIRS tag can be used to specify one or more directories that
2852# contain dia files that are included in the documentation (see the \diafile
2853# command).
2854
2855DIAFILE_DIRS =
2856
2857# When using PlantUML, the PLANTUML_JAR_PATH tag should be used to specify the
2858# path where java can find the plantuml.jar file or to the filename of jar file
2859# to be used. If left blank, it is assumed PlantUML is not used or called during
2860# a preprocessing step. Doxygen will generate a warning when it encounters a
2861# \startuml command in this case and will not generate output for the diagram.
2862
2863PLANTUML_JAR_PATH =
2864
2865# When using PlantUML, the PLANTUML_CFG_FILE tag can be used to specify a
2866# configuration file for PlantUML.
2867
2868PLANTUML_CFG_FILE =
2869
2870# When using PlantUML, the specified paths are searched for files specified by
2871# the !include statement in a PlantUML block.
2872
2873PLANTUML_INCLUDE_PATH =
2874
2875# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that
2876# contain PlantUml files that are included in the documentation (see the
2877# \plantumlfile command).
2878
2879PLANTUMLFILE_DIRS =
2880
2881# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2882# that will be shown in the graph. If the number of nodes in a graph becomes
2883# larger than this value, Doxygen will truncate the graph, which is visualized
2884# by representing a node as a red box. Note that if the number of direct
2885# children of the root node in a graph is already larger than
2886# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2887# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2888# Minimum value: 0, maximum value: 10000, default value: 50.
2889# This tag requires that the tag HAVE_DOT is set to YES.
2890
2891DOT_GRAPH_MAX_NODES = 50
2892
2893# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2894# generated by dot. A depth value of 3 means that only nodes reachable from the
2895# root by following a path via at most 3 edges will be shown. Nodes that lay
2896# further from the root node will be omitted. Note that setting this option to 1
2897# or 2 may greatly reduce the computation time needed for large code bases. Also
2898# note that the size of a graph can be further restricted by
2899# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2900# Minimum value: 0, maximum value: 1000, default value: 0.
2901# This tag requires that the tag HAVE_DOT is set to YES.
2902
2903MAX_DOT_GRAPH_DEPTH = 0
2904
2905# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2906# files in one run (i.e. multiple -o and -T options on the command line). This
2907# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2908# this, this feature is disabled by default.
2909# The default value is: NO.
2910# This tag requires that the tag HAVE_DOT is set to YES.
2911
2912DOT_MULTI_TARGETS = NO
2913
2914# If the GENERATE_LEGEND tag is set to YES Doxygen will generate a legend page
2915# explaining the meaning of the various boxes and arrows in the dot generated
2916# graphs.
2917# Note: This tag requires that UML_LOOK isn't set, i.e. the Doxygen internal
2918# graphical representation for inheritance and collaboration diagrams is used.
2919# The default value is: YES.
2920# This tag requires that the tag HAVE_DOT is set to YES.
2921
2922GENERATE_LEGEND = YES
2923
2924# If the DOT_CLEANUP tag is set to YES, Doxygen will remove the intermediate
2925# files that are used to generate the various graphs.
2926#
2927# Note: This setting is not only used for dot files but also for msc temporary
2928# files.
2929# The default value is: YES.
2930
2931DOT_CLEANUP = YES
2932
2933# You can define message sequence charts within Doxygen comments using the \msc
2934# command. If the MSCGEN_TOOL tag is left empty (the default), then Doxygen will
2935# use a built-in version of mscgen tool to produce the charts. Alternatively,
2936# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2937# specifying prog as the value, Doxygen will call the tool as prog -T
2938# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2939# output file formats "png", "eps", "svg", and "ismap".
2940
2941MSCGEN_TOOL =
2942
2943# The MSCFILE_DIRS tag can be used to specify one or more directories that
2944# contain msc files that are included in the documentation (see the \mscfile
2945# command).
2946
2947MSCFILE_DIRS =