Debian Codegraph @

.github/workflows/misc/Doxyfile

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