Debian Codegraph @

doc/Doxyfile

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