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