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