• R/O
  • HTTP
  • SSH
  • HTTPS

hengband: Commit

変愚蛮怒のメインリポジトリです


Commit MetaInfo

Revision91e2ef55ad9e2cefa8f0f030f005ef3fc48f576d (tree)
Time2019-02-26 23:47:34
Authordeskull <deskull@user...>
Commiterdeskull

Log Message

[modify] doxyfile更新。 / update doxyfile.

Change Summary

Incremental Difference

--- a/doxygen/Hengband.doxyfile
+++ b/doxygen/Hengband.doxyfile
@@ -1,4 +1,4 @@
1-# Doxyfile 1.8.7
1+# Doxyfile 1.8.15
22
33 # This file describes the settings to be used by the documentation system
44 # doxygen (www.doxygen.org) for a project.
@@ -17,11 +17,11 @@
1717 # Project related configuration options
1818 #---------------------------------------------------------------------------
1919
20-# This tag specifies the encoding used for all characters in the config file
21-# that follow. The default is UTF-8 which is also the encoding used for all text
22-# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23-# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24-# for the list of possible encodings.
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.
2525 # The default value is: UTF-8.
2626
2727 DOXYFILE_ENCODING = UTF-8
@@ -44,12 +44,12 @@ PROJECT_NUMBER = 2.2.1
4444 # for a project that appears at the top of each page and should give viewer a
4545 # quick idea about the purpose of the project. Keep the description short.
4646
47-PROJECT_BRIEF =
47+PROJECT_BRIEF =
4848
49-# With the PROJECT_LOGO tag one can specify an logo or icon that is included in
50-# the documentation. The maximum height of the logo should not exceed 55 pixels
51-# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
52-# to the output directory.
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.
5353
5454 PROJECT_LOGO = hengband_title.png
5555
@@ -60,7 +60,7 @@ PROJECT_LOGO = hengband_title.png
6060
6161 OUTPUT_DIRECTORY = .
6262
63-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
63+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6464 # directories (in 2 levels) under the output directory of each output format and
6565 # will distribute the generated files over these directories. Enabling this
6666 # option can be useful when feeding doxygen a huge amount of source files, where
@@ -93,14 +93,22 @@ ALLOW_UNICODE_NAMES = NO
9393
9494 OUTPUT_LANGUAGE = Japanese
9595
96-# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member
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
97105 # descriptions after the members that are listed in the file and class
98106 # documentation (similar to Javadoc). Set to NO to disable this.
99107 # The default value is: YES.
100108
101109 BRIEF_MEMBER_DESC = YES
102110
103-# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief
111+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104112 # description of a member or function before the detailed description
105113 #
106114 # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
@@ -118,7 +126,7 @@ REPEAT_BRIEF = YES
118126 # the entity):The $name class, The $name widget, The $name file, is, provides,
119127 # specifies, contains, represents, a, an and the.
120128
121-ABBREVIATE_BRIEF =
129+ABBREVIATE_BRIEF =
122130
123131 # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
124132 # doxygen will generate a detailed section even if there is only a brief
@@ -135,7 +143,7 @@ ALWAYS_DETAILED_SEC = NO
135143
136144 INLINE_INHERITED_MEMB = NO
137145
138-# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path
146+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
139147 # before files name in the file list and in the header files. If set to NO the
140148 # shortest path that makes the file name unique will be used
141149 # The default value is: YES.
@@ -152,7 +160,7 @@ FULL_PATH_NAMES = YES
152160 # will be relative from the directory where doxygen is started.
153161 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
154162
155-STRIP_FROM_PATH =
163+STRIP_FROM_PATH =
156164
157165 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
158166 # path mentioned in the documentation of a class, which tells the reader which
@@ -161,7 +169,7 @@ STRIP_FROM_PATH =
161169 # specify the list of include paths that are normally passed to the compiler
162170 # using the -I flag.
163171
164-STRIP_FROM_INC_PATH =
172+STRIP_FROM_INC_PATH =
165173
166174 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
167175 # less readable) file names. This can be useful is your file systems doesn't
@@ -205,9 +213,9 @@ MULTILINE_CPP_IS_BRIEF = NO
205213
206214 INHERIT_DOCS = YES
207215
208-# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a
209-# new page for each member. If set to NO, the documentation of a member will be
210-# part of the file/class/namespace that contains it.
216+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
217+# page for each member. If set to NO, the documentation of a member will be part
218+# of the file/class/namespace that contains it.
211219 # The default value is: NO.
212220
213221 SEPARATE_MEMBER_PAGES = NO
@@ -226,15 +234,20 @@ TAB_SIZE = 4
226234 # will allow you to put the command \sideeffect (or @sideeffect) in the
227235 # documentation, which will result in a user-defined paragraph with heading
228236 # "Side Effects:". You can put \n's in the value part of an alias to insert
229-# newlines.
237+# newlines (in the resulting output). You can put ^^ in the value part of an
238+# alias to insert a newline as if a physical newline was in the original file.
239+# When you need a literal { or } or , in the value part of an alias you have to
240+# escape them by means of a backslash (\), this can lead to conflicts with the
241+# commands \{ and \} for these it is advised to use the version @{ and @} or use
242+# a double escape (\\{ and \\})
230243
231-ALIASES =
244+ALIASES =
232245
233246 # This tag can be used to specify a number of word-keyword mappings (TCL only).
234247 # A mapping has the form "name=value". For example adding "class=itcl::class"
235248 # will allow you to use the command class in the itcl::class meaning.
236249
237-TCL_SUBST =
250+TCL_SUBST =
238251
239252 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
240253 # only. Doxygen will then generate output that is more tailored for C. For
@@ -264,19 +277,28 @@ OPTIMIZE_FOR_FORTRAN = NO
264277
265278 OPTIMIZE_OUTPUT_VHDL = NO
266279
280+# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
281+# sources only. Doxygen will then generate output that is more tailored for that
282+# language. For instance, namespaces will be presented as modules, types will be
283+# separated into more groups, etc.
284+# The default value is: NO.
285+
286+OPTIMIZE_OUTPUT_SLICE = NO
287+
267288 # Doxygen selects the parser to use depending on the extension of the files it
268289 # parses. With this tag you can assign which parser to use for a given
269290 # extension. Doxygen has a built-in mapping, but you can override or extend it
270291 # using this tag. The format is ext=language, where ext is a file extension, and
271292 # language is one of the parsers supported by doxygen: IDL, Java, Javascript,
272-# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
273-# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
274-# Fortran. In the later case the parser tries to guess whether the code is fixed
275-# or free formatted code, this is the default for Fortran type files), VHDL. For
276-# instance to make doxygen treat .inc files as Fortran files (default is PHP),
277-# and .f files as C (default is Fortran), use: inc=Fortran f=C.
293+# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice,
294+# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
295+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
296+# tries to guess whether the code is fixed or free formatted code, this is the
297+# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat
298+# .inc files as Fortran files (default is PHP), and .f files as C (default is
299+# Fortran), use: inc=Fortran f=C.
278300 #
279-# Note For files without extension you can use no_extension as a placeholder.
301+# Note: For files without extension you can use no_extension as a placeholder.
280302 #
281303 # Note that for custom extensions you also need to set FILE_PATTERNS otherwise
282304 # the files are not read by doxygen.
@@ -286,7 +308,7 @@ EXTENSION_MAPPING = css=Fortran \
286308
287309 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
288310 # according to the Markdown format, which allows for more readable
289-# documentation. See http://daringfireball.net/projects/markdown/ for details.
311+# documentation. See https://daringfireball.net/projects/markdown/ for details.
290312 # The output of markdown processing is further processed by doxygen, so you can
291313 # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
292314 # case of backward compatibilities issues.
@@ -294,10 +316,19 @@ EXTENSION_MAPPING = css=Fortran \
294316
295317 MARKDOWN_SUPPORT = YES
296318
319+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
320+# to that level are automatically included in the table of contents, even if
321+# they do not have an id attribute.
322+# Note: This feature currently applies only to Markdown headings.
323+# Minimum value: 0, maximum value: 99, default value: 0.
324+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
325+
326+TOC_INCLUDE_HEADINGS = 0
327+
297328 # When enabled doxygen tries to link words that correspond to documented
298329 # classes, or namespaces to their corresponding documentation. Such a link can
299-# be prevented in individual cases by by putting a % sign in front of the word
300-# or globally by setting AUTOLINK_SUPPORT to NO.
330+# be prevented in individual cases by putting a % sign in front of the word or
331+# globally by setting AUTOLINK_SUPPORT to NO.
301332 # The default value is: YES.
302333
303334 AUTOLINK_SUPPORT = YES
@@ -319,7 +350,7 @@ BUILTIN_STL_SUPPORT = NO
319350 CPP_CLI_SUPPORT = NO
320351
321352 # Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
322-# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
353+# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
323354 # will parse them like normal C++ but will assume all classes use public instead
324355 # of private inheritance when no explicit protection keyword is present.
325356 # The default value is: NO.
@@ -337,13 +368,20 @@ SIP_SUPPORT = NO
337368 IDL_PROPERTY_SUPPORT = YES
338369
339370 # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
340-# tag is set to YES, then doxygen will reuse the documentation of the first
371+# tag is set to YES then doxygen will reuse the documentation of the first
341372 # member in the group (if any) for the other members of the group. By default
342373 # all members of a group must be documented explicitly.
343374 # The default value is: NO.
344375
345376 DISTRIBUTE_GROUP_DOC = NO
346377
378+# If one adds a struct or class to a group and this option is enabled, then also
379+# any nested class or struct is added to the same group. By default this option
380+# is disabled and one has to add nested compounds explicitly via \ingroup.
381+# The default value is: NO.
382+
383+GROUP_NESTED_COMPOUNDS = NO
384+
347385 # Set the SUBGROUPING tag to YES to allow class member groups of the same type
348386 # (for instance a group of public functions) to be put as a subgroup of that
349387 # type (e.g. under the Public Functions section). Set it to NO to prevent
@@ -402,7 +440,7 @@ LOOKUP_CACHE_SIZE = 0
402440 # Build related configuration options
403441 #---------------------------------------------------------------------------
404442
405-# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
443+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
406444 # documentation are documented, even if no documentation was available. Private
407445 # class members and static file members will be hidden unless the
408446 # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
@@ -412,35 +450,35 @@ LOOKUP_CACHE_SIZE = 0
412450
413451 EXTRACT_ALL = YES
414452
415-# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will
453+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
416454 # be included in the documentation.
417455 # The default value is: NO.
418456
419457 EXTRACT_PRIVATE = YES
420458
421-# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
459+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
422460 # scope will be included in the documentation.
423461 # The default value is: NO.
424462
425463 EXTRACT_PACKAGE = NO
426464
427-# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
465+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
428466 # included in the documentation.
429467 # The default value is: NO.
430468
431469 EXTRACT_STATIC = YES
432470
433-# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
434-# locally in source files will be included in the documentation. If set to NO
471+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
472+# locally in source files will be included in the documentation. If set to NO,
435473 # only classes defined in header files are included. Does not have any effect
436474 # for Java sources.
437475 # The default value is: YES.
438476
439477 EXTRACT_LOCAL_CLASSES = YES
440478
441-# This flag is only useful for Objective-C code. When set to YES local methods,
479+# This flag is only useful for Objective-C code. If set to YES, local methods,
442480 # which are defined in the implementation section but not in the interface are
443-# included in the documentation. If set to NO only methods in the interface are
481+# included in the documentation. If set to NO, only methods in the interface are
444482 # included.
445483 # The default value is: NO.
446484
@@ -465,21 +503,21 @@ HIDE_UNDOC_MEMBERS = NO
465503
466504 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
467505 # undocumented classes that are normally visible in the class hierarchy. If set
468-# to NO these classes will be included in the various overviews. This option has
469-# no effect if EXTRACT_ALL is enabled.
506+# to NO, these classes will be included in the various overviews. This option
507+# has no effect if EXTRACT_ALL is enabled.
470508 # The default value is: NO.
471509
472510 HIDE_UNDOC_CLASSES = NO
473511
474512 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
475-# (class|struct|union) declarations. If set to NO these declarations will be
513+# (class|struct|union) declarations. If set to NO, these declarations will be
476514 # included in the documentation.
477515 # The default value is: NO.
478516
479517 HIDE_FRIEND_COMPOUNDS = NO
480518
481519 # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
482-# documentation blocks found inside the body of a function. If set to NO these
520+# documentation blocks found inside the body of a function. If set to NO, these
483521 # blocks will be appended to the function's detailed documentation block.
484522 # The default value is: NO.
485523
@@ -493,7 +531,7 @@ HIDE_IN_BODY_DOCS = NO
493531 INTERNAL_DOCS = NO
494532
495533 # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
496-# names in lower-case letters. If set to YES upper-case letters are also
534+# names in lower-case letters. If set to YES, upper-case letters are also
497535 # allowed. This is useful if you have classes or files whose names only differ
498536 # in case and if your file system supports case sensitive file names. Windows
499537 # and Mac users are advised to set this option to NO.
@@ -502,12 +540,19 @@ INTERNAL_DOCS = NO
502540 CASE_SENSE_NAMES = NO
503541
504542 # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
505-# their full class and namespace scopes in the documentation. If set to YES the
543+# their full class and namespace scopes in the documentation. If set to YES, the
506544 # scope will be hidden.
507545 # The default value is: NO.
508546
509547 HIDE_SCOPE_NAMES = YES
510548
549+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
550+# append additional text to a page's title, such as Class Reference. If set to
551+# YES the compound reference will be hidden.
552+# The default value is: NO.
553+
554+HIDE_COMPOUND_REFERENCE= NO
555+
511556 # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
512557 # the files that are included by a file in the documentation of that file.
513558 # The default value is: YES.
@@ -535,14 +580,14 @@ INLINE_INFO = YES
535580
536581 # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
537582 # (detailed) documentation of file and class members alphabetically by member
538-# name. If set to NO the members will appear in declaration order.
583+# name. If set to NO, the members will appear in declaration order.
539584 # The default value is: YES.
540585
541586 SORT_MEMBER_DOCS = YES
542587
543588 # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
544589 # descriptions of file, namespace and class members alphabetically by member
545-# name. If set to NO the members will appear in declaration order. Note that
590+# name. If set to NO, the members will appear in declaration order. Note that
546591 # this will also influence the order of the classes in the class list.
547592 # The default value is: NO.
548593
@@ -587,27 +632,25 @@ SORT_BY_SCOPE_NAME = NO
587632
588633 STRICT_PROTO_MATCHING = NO
589634
590-# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the
591-# todo list. This list is created by putting \todo commands in the
592-# documentation.
635+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
636+# list. This list is created by putting \todo commands in the documentation.
593637 # The default value is: YES.
594638
595639 GENERATE_TODOLIST = YES
596640
597-# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the
598-# test list. This list is created by putting \test commands in the
599-# documentation.
641+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
642+# list. This list is created by putting \test commands in the documentation.
600643 # The default value is: YES.
601644
602645 GENERATE_TESTLIST = YES
603646
604-# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug
647+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
605648 # list. This list is created by putting \bug commands in the documentation.
606649 # The default value is: YES.
607650
608651 GENERATE_BUGLIST = YES
609652
610-# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO)
653+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
611654 # the deprecated list. This list is created by putting \deprecated commands in
612655 # the documentation.
613656 # The default value is: YES.
@@ -618,7 +661,7 @@ GENERATE_DEPRECATEDLIST= YES
618661 # sections, marked by \if <section_label> ... \endif and \cond <section_label>
619662 # ... \endcond blocks.
620663
621-ENABLED_SECTIONS =
664+ENABLED_SECTIONS =
622665
623666 # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
624667 # initial value of a variable or macro / define can have for it to appear in the
@@ -632,8 +675,8 @@ ENABLED_SECTIONS =
632675 MAX_INITIALIZER_LINES = 30
633676
634677 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
635-# the bottom of the documentation of classes and structs. If set to YES the list
636-# will mention the files that were used to generate the documentation.
678+# the bottom of the documentation of classes and structs. If set to YES, the
679+# list will mention the files that were used to generate the documentation.
637680 # The default value is: YES.
638681
639682 SHOW_USED_FILES = YES
@@ -660,7 +703,7 @@ SHOW_NAMESPACES = YES
660703 # by doxygen. Whatever the program writes to standard output is used as the file
661704 # version. For an example see the documentation.
662705
663-FILE_VERSION_FILTER =
706+FILE_VERSION_FILTER =
664707
665708 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
666709 # by doxygen. The layout file controls the global structure of the generated
@@ -673,18 +716,17 @@ FILE_VERSION_FILTER =
673716 # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
674717 # tag is left empty.
675718
676-LAYOUT_FILE =
719+LAYOUT_FILE =
677720
678721 # The CITE_BIB_FILES tag can be used to specify one or more bib files containing
679722 # the reference definitions. This must be a list of .bib files. The .bib
680723 # extension is automatically appended if omitted. This requires the bibtex tool
681-# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
724+# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
682725 # For LaTeX the style of the bibliography can be controlled using
683726 # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
684-# search path. Do not use file names with spaces, bibtex cannot handle them. See
685-# also \cite for info how to create references.
727+# search path. See also \cite for info how to create references.
686728
687-CITE_BIB_FILES =
729+CITE_BIB_FILES =
688730
689731 #---------------------------------------------------------------------------
690732 # Configuration options related to warning and progress messages
@@ -698,7 +740,7 @@ CITE_BIB_FILES =
698740 QUIET = NO
699741
700742 # The WARNINGS tag can be used to turn on/off the warning messages that are
701-# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES
743+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
702744 # this implies that the warnings are on.
703745 #
704746 # Tip: Turn warnings on while writing the documentation.
@@ -706,7 +748,7 @@ QUIET = NO
706748
707749 WARNINGS = YES
708750
709-# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate
751+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
710752 # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
711753 # will automatically be disabled.
712754 # The default value is: YES.
@@ -723,12 +765,19 @@ WARN_IF_DOC_ERROR = YES
723765
724766 # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
725767 # are documented, but have no documentation for their parameters or return
726-# value. If set to NO doxygen will only warn about wrong or incomplete parameter
727-# documentation, but not about the absence of documentation.
768+# value. If set to NO, doxygen will only warn about wrong or incomplete
769+# parameter documentation, but not about the absence of documentation. If
770+# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
728771 # The default value is: NO.
729772
730773 WARN_NO_PARAMDOC = YES
731774
775+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
776+# a warning is encountered.
777+# The default value is: NO.
778+
779+WARN_AS_ERROR = NO
780+
732781 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
733782 # can produce. The string should contain the $file, $line, and $text tags, which
734783 # will be replaced by the file and line number from which the warning originated
@@ -743,7 +792,7 @@ WARN_FORMAT = "$file:$line: $text"
743792 # messages should be written. If left blank the output is written to standard
744793 # error (stderr).
745794
746-WARN_LOGFILE =
795+WARN_LOGFILE =
747796
748797 #---------------------------------------------------------------------------
749798 # Configuration options related to the input files
@@ -752,7 +801,7 @@ WARN_LOGFILE =
752801 # The INPUT tag is used to specify the files and/or directories that contain
753802 # documented source files. You may enter file names like myfile.cpp or
754803 # directories like /usr/src/myproject. Separate the files or directories with
755-# spaces.
804+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
756805 # Note: If this tag is empty the current directory is searched.
757806
758807 INPUT = ../src
@@ -760,7 +809,7 @@ INPUT = ../src
760809 # This tag can be used to specify the character encoding of the source files
761810 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
762811 # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
763-# documentation (see: http://www.gnu.org/software/libiconv) for the list of
812+# documentation (see: https://www.gnu.org/software/libiconv/) for the list of
764813 # possible encodings.
765814 # The default value is: UTF-8.
766815
@@ -768,12 +817,17 @@ INPUT_ENCODING = EUC-JP
768817
769818 # If the value of the INPUT tag contains directories, you can use the
770819 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
771-# *.h) to filter out the source-files in the directories. If left blank the
772-# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
773-# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
774-# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
775-# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
776-# *.qsf, *.as and *.js.
820+# *.h) to filter out the source-files in the directories.
821+#
822+# Note that for custom extensions or not directly supported extensions you also
823+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
824+# read by doxygen.
825+#
826+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
827+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
828+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
829+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
830+# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
777831
778832 FILE_PATTERNS = *.c \
779833 *.h
@@ -791,7 +845,7 @@ RECURSIVE = NO
791845 # Note that relative paths are relative to the directory from which doxygen is
792846 # run.
793847
794-EXCLUDE =
848+EXCLUDE =
795849
796850 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
797851 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -807,7 +861,7 @@ EXCLUDE_SYMLINKS = NO
807861 # Note that the wildcards are matched against the file with absolute path, so to
808862 # exclude all test directories for example use the pattern */test/*
809863
810-EXCLUDE_PATTERNS =
864+EXCLUDE_PATTERNS =
811865
812866 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
813867 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -818,20 +872,20 @@ EXCLUDE_PATTERNS =
818872 # Note that the wildcards are matched against the file with absolute path, so to
819873 # exclude all test directories use the pattern */test/*
820874
821-EXCLUDE_SYMBOLS =
875+EXCLUDE_SYMBOLS =
822876
823877 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
824878 # that contain example code fragments that are included (see the \include
825879 # command).
826880
827-EXAMPLE_PATH =
881+EXAMPLE_PATH =
828882
829883 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
830884 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
831885 # *.h) to filter out the source-files in the directories. If left blank all
832886 # files are included.
833887
834-EXAMPLE_PATTERNS =
888+EXAMPLE_PATTERNS =
835889
836890 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
837891 # searched for input files to be used with the \include or \dontinclude commands
@@ -844,7 +898,7 @@ EXAMPLE_RECURSIVE = NO
844898 # that contain images that are to be included in the documentation (see the
845899 # \image command).
846900
847-IMAGE_PATH =
901+IMAGE_PATH =
848902
849903 # The INPUT_FILTER tag can be used to specify a program that doxygen should
850904 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -860,8 +914,12 @@ IMAGE_PATH =
860914 # Note that the filter must not add or remove lines; it is applied before the
861915 # code is scanned, but not when the output code is generated. If lines are added
862916 # or removed, the anchors will not be placed correctly.
917+#
918+# Note that for custom extensions or not directly supported extensions you also
919+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
920+# properly processed by doxygen.
863921
864-INPUT_FILTER =
922+INPUT_FILTER =
865923
866924 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
867925 # basis. Doxygen will compare the file name with each pattern and apply the
@@ -869,11 +927,15 @@ INPUT_FILTER =
869927 # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
870928 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
871929 # patterns match the file name, INPUT_FILTER is applied.
930+#
931+# Note that for custom extensions or not directly supported extensions you also
932+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
933+# properly processed by doxygen.
872934
873-FILTER_PATTERNS =
935+FILTER_PATTERNS =
874936
875937 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
876-# INPUT_FILTER ) will also be used to filter the input files that are used for
938+# INPUT_FILTER) will also be used to filter the input files that are used for
877939 # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
878940 # The default value is: NO.
879941
@@ -885,14 +947,14 @@ FILTER_SOURCE_FILES = NO
885947 # *.ext= (so without naming a filter).
886948 # This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
887949
888-FILTER_SOURCE_PATTERNS =
950+FILTER_SOURCE_PATTERNS =
889951
890952 # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
891953 # is part of the input, its contents will be placed on the main page
892954 # (index.html). This can be useful if you have a project on for instance GitHub
893955 # and want to reuse the introduction page also for the doxygen output.
894956
895-USE_MDFILE_AS_MAINPAGE =
957+USE_MDFILE_AS_MAINPAGE =
896958
897959 #---------------------------------------------------------------------------
898960 # Configuration options related to source browsing
@@ -921,7 +983,7 @@ INLINE_SOURCES = NO
921983 STRIP_CODE_COMMENTS = NO
922984
923985 # If the REFERENCED_BY_RELATION tag is set to YES then for each documented
924-# function all documented functions referencing it will be listed.
986+# entity all documented functions referencing it will be listed.
925987 # The default value is: NO.
926988
927989 REFERENCED_BY_RELATION = NO
@@ -933,7 +995,7 @@ REFERENCED_BY_RELATION = NO
933995 REFERENCES_RELATION = NO
934996
935997 # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
936-# to YES, then the hyperlinks from functions in REFERENCES_RELATION and
998+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
937999 # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
9381000 # link to the documentation.
9391001 # The default value is: YES.
@@ -953,12 +1015,12 @@ SOURCE_TOOLTIPS = YES
9531015 # If the USE_HTAGS tag is set to YES then the references to source code will
9541016 # point to the HTML generated by the htags(1) tool instead of doxygen built-in
9551017 # source browser. The htags tool is part of GNU's global source tagging system
956-# (see http://www.gnu.org/software/global/global.html). You will need version
1018+# (see https://www.gnu.org/software/global/global.html). You will need version
9571019 # 4.8.6 or higher.
9581020 #
9591021 # To use it do the following:
9601022 # - Install the latest version of global
961-# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1023+# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
9621024 # - Make sure the INPUT points to the root of the source tree
9631025 # - Run doxygen as normal
9641026 #
@@ -980,13 +1042,13 @@ USE_HTAGS = NO
9801042
9811043 VERBATIM_HEADERS = YES
9821044
983-# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
1045+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
9841046 # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
9851047 # cost of reduced performance. This can be particularly helpful with template
9861048 # rich C++ code for which doxygen's built-in parser lacks the necessary type
9871049 # information.
9881050 # Note: The availability of this option depends on whether or not doxygen was
989-# compiled with the --with-libclang option.
1051+# generated with the -Duse_libclang=ON option for CMake.
9901052 # The default value is: NO.
9911053
9921054 CLANG_ASSISTED_PARSING = NO
@@ -997,7 +1059,17 @@ CLANG_ASSISTED_PARSING = NO
9971059 # specified with INPUT and INCLUDE_PATH.
9981060 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
9991061
1000-CLANG_OPTIONS =
1062+CLANG_OPTIONS =
1063+
1064+# If clang assisted parsing is enabled you can provide the clang parser with the
1065+# path to the compilation database (see:
1066+# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files
1067+# were built. This is equivalent to specifying the "-p" option to a clang tool,
1068+# such as clang-check. These options will then be passed to the parser.
1069+# Note: The availability of this option depends on whether or not doxygen was
1070+# generated with the -Duse_libclang=ON option for CMake.
1071+
1072+CLANG_DATABASE_PATH =
10011073
10021074 #---------------------------------------------------------------------------
10031075 # Configuration options related to the alphabetical class index
@@ -1023,13 +1095,13 @@ COLS_IN_ALPHA_INDEX = 5
10231095 # while generating the index headers.
10241096 # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
10251097
1026-IGNORE_PREFIX =
1098+IGNORE_PREFIX =
10271099
10281100 #---------------------------------------------------------------------------
10291101 # Configuration options related to the HTML output
10301102 #---------------------------------------------------------------------------
10311103
1032-# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output
1104+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
10331105 # The default value is: YES.
10341106
10351107 GENERATE_HTML = YES
@@ -1067,7 +1139,7 @@ HTML_FILE_EXTENSION = .html
10671139 # of the possible markers and block names see the documentation.
10681140 # This tag requires that the tag GENERATE_HTML is set to YES.
10691141
1070-HTML_HEADER =
1142+HTML_HEADER =
10711143
10721144 # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
10731145 # generated HTML page. If the tag is left blank doxygen will generate a standard
@@ -1077,7 +1149,7 @@ HTML_HEADER =
10771149 # that doxygen normally uses.
10781150 # This tag requires that the tag GENERATE_HTML is set to YES.
10791151
1080-HTML_FOOTER =
1152+HTML_FOOTER =
10811153
10821154 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
10831155 # sheet that is used by each HTML page. It can be used to fine-tune the look of
@@ -1091,16 +1163,18 @@ HTML_FOOTER =
10911163
10921164 HTML_STYLESHEET = ./doxygen.css
10931165
1094-# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
1095-# defined cascading style sheet that is included after the standard style sheets
1166+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1167+# cascading style sheets that are included after the standard style sheets
10961168 # created by doxygen. Using this option one can overrule certain style aspects.
10971169 # This is preferred over using HTML_STYLESHEET since it does not replace the
1098-# standard style sheet and is therefor more robust against future updates.
1099-# Doxygen will copy the style sheet file to the output directory. For an example
1100-# see the documentation.
1170+# standard style sheet and is therefore more robust against future updates.
1171+# Doxygen will copy the style sheet files to the output directory.
1172+# Note: The order of the extra style sheet files is of importance (e.g. the last
1173+# style sheet in the list overrules the setting of the previous ones in the
1174+# list). For an example see the documentation.
11011175 # This tag requires that the tag GENERATE_HTML is set to YES.
11021176
1103-HTML_EXTRA_STYLESHEET =
1177+HTML_EXTRA_STYLESHEET =
11041178
11051179 # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
11061180 # other source files which should be copied to the HTML output directory. Note
@@ -1110,12 +1184,12 @@ HTML_EXTRA_STYLESHEET =
11101184 # files will be copied as-is; there are no commands or markers available.
11111185 # This tag requires that the tag GENERATE_HTML is set to YES.
11121186
1113-HTML_EXTRA_FILES =
1187+HTML_EXTRA_FILES =
11141188
11151189 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1116-# will adjust the colors in the stylesheet and background images according to
1190+# will adjust the colors in the style sheet and background images according to
11171191 # this color. Hue is specified as an angle on a colorwheel, see
1118-# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1192+# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
11191193 # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
11201194 # purple, and 360 is red again.
11211195 # Minimum value: 0, maximum value: 359, default value: 220.
@@ -1144,12 +1218,24 @@ HTML_COLORSTYLE_GAMMA = 80
11441218
11451219 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
11461220 # page will contain the date and time when the page was generated. Setting this
1147-# to NO can help when comparing the output of multiple runs.
1148-# The default value is: YES.
1221+# to YES can help to show when doxygen was last run and thus if the
1222+# documentation is up to date.
1223+# The default value is: NO.
11491224 # This tag requires that the tag GENERATE_HTML is set to YES.
11501225
11511226 HTML_TIMESTAMP = YES
11521227
1228+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1229+# documentation will contain a main index with vertical navigation menus that
1230+# are dynamically created via Javascript. If disabled, the navigation index will
1231+# consists of multiple levels of tabs that are statically embedded in every HTML
1232+# page. Disable this option to support browsers that do not have Javascript,
1233+# like the Qt help browser.
1234+# The default value is: YES.
1235+# This tag requires that the tag GENERATE_HTML is set to YES.
1236+
1237+HTML_DYNAMIC_MENUS = YES
1238+
11531239 # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
11541240 # documentation will contain sections that can be hidden and shown after the
11551241 # page has loaded.
@@ -1173,13 +1259,13 @@ HTML_INDEX_NUM_ENTRIES = 100
11731259
11741260 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
11751261 # generated that can be used as input for Apple's Xcode 3 integrated development
1176-# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1177-# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1262+# environment (see: https://developer.apple.com/xcode/), introduced with OSX
1263+# 10.5 (Leopard). To create a documentation set, doxygen will generate a
11781264 # Makefile in the HTML output directory. Running make will produce the docset in
11791265 # that directory and running make install will install the docset in
11801266 # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1181-# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1182-# for more information.
1267+# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1268+# genXcode/_index.html for more information.
11831269 # The default value is: NO.
11841270 # This tag requires that the tag GENERATE_HTML is set to YES.
11851271
@@ -1218,7 +1304,7 @@ DOCSET_PUBLISHER_NAME = Publisher
12181304 # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
12191305 # additional HTML index files: index.hhp, index.hhc, and index.hhk. The
12201306 # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1221-# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1307+# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on
12221308 # Windows.
12231309 #
12241310 # The HTML Help Workshop contains a compiler that can convert all HTML output
@@ -1238,31 +1324,31 @@ GENERATE_HTMLHELP = NO
12381324 # written to the html output directory.
12391325 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
12401326
1241-CHM_FILE =
1327+CHM_FILE =
12421328
12431329 # The HHC_LOCATION tag can be used to specify the location (absolute path
1244-# including file name) of the HTML help compiler ( hhc.exe). If non-empty
1330+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
12451331 # doxygen will try to run the HTML help compiler on the generated index.hhp.
12461332 # The file has to be specified with full path.
12471333 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
12481334
1249-HHC_LOCATION =
1335+HHC_LOCATION =
12501336
1251-# The GENERATE_CHI flag controls if a separate .chi index file is generated (
1252-# YES) or that it should be included in the master .chm file ( NO).
1337+# The GENERATE_CHI flag controls if a separate .chi index file is generated
1338+# (YES) or that it should be included in the master .chm file (NO).
12531339 # The default value is: NO.
12541340 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
12551341
12561342 GENERATE_CHI = NO
12571343
1258-# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc)
1344+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
12591345 # and project file content.
12601346 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
12611347
1262-CHM_INDEX_ENCODING =
1348+CHM_INDEX_ENCODING =
12631349
1264-# The BINARY_TOC flag controls whether a binary table of contents is generated (
1265-# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
1350+# The BINARY_TOC flag controls whether a binary table of contents is generated
1351+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
12661352 # enables the Previous and Next buttons.
12671353 # The default value is: NO.
12681354 # This tag requires that the tag GENERATE_HTMLHELP is set to YES.
@@ -1290,11 +1376,11 @@ GENERATE_QHP = NO
12901376 # the HTML output folder.
12911377 # This tag requires that the tag GENERATE_QHP is set to YES.
12921378
1293-QCH_FILE =
1379+QCH_FILE =
12941380
12951381 # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
12961382 # Project output. For more information please see Qt Help Project / Namespace
1297-# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1383+# (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
12981384 # The default value is: org.doxygen.Project.
12991385 # This tag requires that the tag GENERATE_QHP is set to YES.
13001386
@@ -1302,7 +1388,7 @@ QHP_NAMESPACE = org.doxygen.Project
13021388
13031389 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
13041390 # Help Project output. For more information please see Qt Help Project / Virtual
1305-# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1391+# Folders (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-
13061392 # folders).
13071393 # The default value is: doc.
13081394 # This tag requires that the tag GENERATE_QHP is set to YES.
@@ -1311,33 +1397,33 @@ QHP_VIRTUAL_FOLDER = doc
13111397
13121398 # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
13131399 # filter to add. For more information please see Qt Help Project / Custom
1314-# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1400+# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
13151401 # filters).
13161402 # This tag requires that the tag GENERATE_QHP is set to YES.
13171403
1318-QHP_CUST_FILTER_NAME =
1404+QHP_CUST_FILTER_NAME =
13191405
13201406 # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
13211407 # custom filter to add. For more information please see Qt Help Project / Custom
1322-# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1408+# Filters (see: http://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-
13231409 # filters).
13241410 # This tag requires that the tag GENERATE_QHP is set to YES.
13251411
1326-QHP_CUST_FILTER_ATTRS =
1412+QHP_CUST_FILTER_ATTRS =
13271413
13281414 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
13291415 # project's filter section matches. Qt Help Project / Filter Attributes (see:
1330-# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1416+# http://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
13311417 # This tag requires that the tag GENERATE_QHP is set to YES.
13321418
1333-QHP_SECT_FILTER_ATTRS =
1419+QHP_SECT_FILTER_ATTRS =
13341420
13351421 # The QHG_LOCATION tag can be used to specify the location of Qt's
13361422 # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
13371423 # generated .qhp file.
13381424 # This tag requires that the tag GENERATE_QHP is set to YES.
13391425
1340-QHG_LOCATION =
1426+QHG_LOCATION =
13411427
13421428 # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
13431429 # generated, together with the HTML files, they form an Eclipse help plugin. To
@@ -1376,7 +1462,7 @@ DISABLE_INDEX = NO
13761462 # index structure (just like the one that is generated for HTML Help). For this
13771463 # to work a browser that supports JavaScript, DHTML, CSS and frames is required
13781464 # (i.e. any modern browser). Windows users are probably better off using the
1379-# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can
1465+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
13801466 # further fine-tune the look of the index. As an example, the default style
13811467 # sheet generated by doxygen has an example that shows how to put an image at
13821468 # the root of the tree instead of the PROJECT_NAME. Since the tree basically has
@@ -1404,7 +1490,7 @@ ENUM_VALUES_PER_LINE = 4
14041490
14051491 TREEVIEW_WIDTH = 250
14061492
1407-# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to
1493+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
14081494 # external symbols imported via tag files in a separate window.
14091495 # The default value is: NO.
14101496 # This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1420,7 +1506,7 @@ EXT_LINKS_IN_WINDOW = NO
14201506
14211507 FORMULA_FONTSIZE = 10
14221508
1423-# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1509+# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
14241510 # generated for formulas are transparent PNGs. Transparent PNGs are not
14251511 # supported properly for IE 6.0, but are supported on all modern browsers.
14261512 #
@@ -1432,8 +1518,8 @@ FORMULA_FONTSIZE = 10
14321518 FORMULA_TRANSPARENT = YES
14331519
14341520 # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1435-# http://www.mathjax.org) which uses client side Javascript for the rendering
1436-# instead of using prerendered bitmaps. Use this if you do not have LaTeX
1521+# https://www.mathjax.org) which uses client side Javascript for the rendering
1522+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
14371523 # installed or if you want to formulas look prettier in the HTML output. When
14381524 # enabled you may also need to install MathJax separately and configure the path
14391525 # to it using the MATHJAX_RELPATH option.
@@ -1459,8 +1545,8 @@ MATHJAX_FORMAT = HTML-CSS
14591545 # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
14601546 # Content Delivery Network so you can quickly see the result without installing
14611547 # MathJax. However, it is strongly recommended to install a local copy of
1462-# MathJax from http://www.mathjax.org before deployment.
1463-# The default value is: http://cdn.mathjax.org/mathjax/latest.
1548+# MathJax from https://www.mathjax.org before deployment.
1549+# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/.
14641550 # This tag requires that the tag USE_MATHJAX is set to YES.
14651551
14661552 MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
@@ -1470,7 +1556,7 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
14701556 # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
14711557 # This tag requires that the tag USE_MATHJAX is set to YES.
14721558
1473-MATHJAX_EXTENSIONS =
1559+MATHJAX_EXTENSIONS =
14741560
14751561 # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
14761562 # of code that will be used on startup of the MathJax code. See the MathJax site
@@ -1478,7 +1564,7 @@ MATHJAX_EXTENSIONS =
14781564 # example see the documentation.
14791565 # This tag requires that the tag USE_MATHJAX is set to YES.
14801566
1481-MATHJAX_CODEFILE =
1567+MATHJAX_CODEFILE =
14821568
14831569 # When the SEARCHENGINE tag is enabled doxygen will generate a search box for
14841570 # the HTML output. The underlying search engine uses javascript and DHTML and
@@ -1519,9 +1605,9 @@ SERVER_BASED_SEARCH = NO
15191605 # external search engine pointed to by the SEARCHENGINE_URL option to obtain the
15201606 # search results.
15211607 #
1522-# Doxygen ships with an example indexer ( doxyindexer) and search engine
1608+# Doxygen ships with an example indexer (doxyindexer) and search engine
15231609 # (doxysearch.cgi) which are based on the open source search engine library
1524-# Xapian (see: http://xapian.org/).
1610+# Xapian (see: https://xapian.org/).
15251611 #
15261612 # See the section "External Indexing and Searching" for details.
15271613 # The default value is: NO.
@@ -1532,13 +1618,13 @@ EXTERNAL_SEARCH = NO
15321618 # The SEARCHENGINE_URL should point to a search engine hosted by a web server
15331619 # which will return the search results when EXTERNAL_SEARCH is enabled.
15341620 #
1535-# Doxygen ships with an example indexer ( doxyindexer) and search engine
1621+# Doxygen ships with an example indexer (doxyindexer) and search engine
15361622 # (doxysearch.cgi) which are based on the open source search engine library
1537-# Xapian (see: http://xapian.org/). See the section "External Indexing and
1623+# Xapian (see: https://xapian.org/). See the section "External Indexing and
15381624 # Searching" for details.
15391625 # This tag requires that the tag SEARCHENGINE is set to YES.
15401626
1541-SEARCHENGINE_URL =
1627+SEARCHENGINE_URL =
15421628
15431629 # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
15441630 # search data is written to a file for indexing by an external tool. With the
@@ -1554,7 +1640,7 @@ SEARCHDATA_FILE = searchdata.xml
15541640 # projects and redirect the results back to the right project.
15551641 # This tag requires that the tag SEARCHENGINE is set to YES.
15561642
1557-EXTERNAL_SEARCH_ID =
1643+EXTERNAL_SEARCH_ID =
15581644
15591645 # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
15601646 # projects other than the one defined by this configuration file, but that are
@@ -1564,13 +1650,13 @@ EXTERNAL_SEARCH_ID =
15641650 # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
15651651 # This tag requires that the tag SEARCHENGINE is set to YES.
15661652
1567-EXTRA_SEARCH_MAPPINGS =
1653+EXTRA_SEARCH_MAPPINGS =
15681654
15691655 #---------------------------------------------------------------------------
15701656 # Configuration options related to the LaTeX output
15711657 #---------------------------------------------------------------------------
15721658
1573-# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output.
1659+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
15741660 # The default value is: YES.
15751661
15761662 GENERATE_LATEX = NO
@@ -1586,22 +1672,35 @@ LATEX_OUTPUT = latex
15861672 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
15871673 # invoked.
15881674 #
1589-# Note that when enabling USE_PDFLATEX this option is only used for generating
1590-# bitmaps for formulas in the HTML output, but not in the Makefile that is
1591-# written to the output directory.
1592-# The default file is: latex.
1675+# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1676+# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1677+# chosen this is overwritten by pdflatex. For specific output languages the
1678+# default can have been set differently, this depends on the implementation of
1679+# the output language.
15931680 # This tag requires that the tag GENERATE_LATEX is set to YES.
15941681
15951682 LATEX_CMD_NAME = latex
15961683
15971684 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
15981685 # index for LaTeX.
1686+# Note: This tag is used in the Makefile / make.bat.
1687+# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1688+# (.tex).
15991689 # The default file is: makeindex.
16001690 # This tag requires that the tag GENERATE_LATEX is set to YES.
16011691
16021692 MAKEINDEX_CMD_NAME = makeindex
16031693
1604-# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX
1694+# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1695+# generate index for LaTeX.
1696+# Note: This tag is used in the generated output file (.tex).
1697+# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1698+# The default value is: \makeindex.
1699+# This tag requires that the tag GENERATE_LATEX is set to YES.
1700+
1701+LATEX_MAKEINDEX_CMD = \makeindex
1702+
1703+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
16051704 # documents. This may be useful for small projects and may help to save some
16061705 # trees in general.
16071706 # The default value is: NO.
@@ -1619,13 +1718,16 @@ COMPACT_LATEX = NO
16191718 PAPER_TYPE = a4
16201719
16211720 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1622-# that should be included in the LaTeX output. To get the times font for
1623-# instance you can specify
1624-# EXTRA_PACKAGES=times
1721+# that should be included in the LaTeX output. The package can be specified just
1722+# by its name or with the correct syntax as to be used with the LaTeX
1723+# \usepackage command. To get the times font for instance you can specify :
1724+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1725+# To use the option intlimits with the amsmath package you can specify:
1726+# EXTRA_PACKAGES=[intlimits]{amsmath}
16251727 # If left blank no extra packages will be included.
16261728 # This tag requires that the tag GENERATE_LATEX is set to YES.
16271729
1628-EXTRA_PACKAGES =
1730+EXTRA_PACKAGES =
16291731
16301732 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
16311733 # generated LaTeX document. The header should contain everything until the first
@@ -1635,22 +1737,35 @@ EXTRA_PACKAGES =
16351737 #
16361738 # Note: Only use a user-defined header if you know what you are doing! The
16371739 # following commands have a special meaning inside the header: $title,
1638-# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
1639-# replace them by respectively the title of the page, the current date and time,
1640-# only the current date, the version number of doxygen, the project name (see
1641-# PROJECT_NAME), or the project number (see PROJECT_NUMBER).
1740+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1741+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1742+# string, for the replacement values of the other commands the user is referred
1743+# to HTML_HEADER.
16421744 # This tag requires that the tag GENERATE_LATEX is set to YES.
16431745
1644-LATEX_HEADER =
1746+LATEX_HEADER =
16451747
16461748 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
16471749 # generated LaTeX document. The footer should contain everything after the last
1648-# chapter. If it is left blank doxygen will generate a standard footer.
1750+# chapter. If it is left blank doxygen will generate a standard footer. See
1751+# LATEX_HEADER for more information on how to generate a default footer and what
1752+# special commands can be used inside the footer.
16491753 #
16501754 # Note: Only use a user-defined footer if you know what you are doing!
16511755 # This tag requires that the tag GENERATE_LATEX is set to YES.
16521756
1653-LATEX_FOOTER =
1757+LATEX_FOOTER =
1758+
1759+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1760+# LaTeX style sheets that are included after the standard style sheets created
1761+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1762+# will copy the style sheet files to the output directory.
1763+# Note: The order of the extra style sheet files is of importance (e.g. the last
1764+# style sheet in the list overrules the setting of the previous ones in the
1765+# list).
1766+# This tag requires that the tag GENERATE_LATEX is set to YES.
1767+
1768+LATEX_EXTRA_STYLESHEET =
16541769
16551770 # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
16561771 # other source files which should be copied to the LATEX_OUTPUT output
@@ -1658,7 +1773,7 @@ LATEX_FOOTER =
16581773 # markers available.
16591774 # This tag requires that the tag GENERATE_LATEX is set to YES.
16601775
1661-LATEX_EXTRA_FILES =
1776+LATEX_EXTRA_FILES =
16621777
16631778 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
16641779 # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
@@ -1669,8 +1784,8 @@ LATEX_EXTRA_FILES =
16691784
16701785 PDF_HYPERLINKS = YES
16711786
1672-# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1673-# the PDF file directly from the LaTeX files. Set this option to YES to get a
1787+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1788+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
16741789 # higher quality PDF documentation.
16751790 # The default value is: YES.
16761791 # This tag requires that the tag GENERATE_LATEX is set to YES.
@@ -1705,17 +1820,33 @@ LATEX_SOURCE_CODE = NO
17051820
17061821 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
17071822 # bibliography, e.g. plainnat, or ieeetr. See
1708-# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1823+# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
17091824 # The default value is: plain.
17101825 # This tag requires that the tag GENERATE_LATEX is set to YES.
17111826
17121827 LATEX_BIB_STYLE = plain
17131828
1829+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1830+# page will contain the date and time when the page was generated. Setting this
1831+# to NO can help when comparing the output of multiple runs.
1832+# The default value is: NO.
1833+# This tag requires that the tag GENERATE_LATEX is set to YES.
1834+
1835+LATEX_TIMESTAMP = NO
1836+
1837+# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1838+# path from which the emoji images will be read. If a relative path is entered,
1839+# it will be relative to the LATEX_OUTPUT directory. If left blank the
1840+# LATEX_OUTPUT directory will be used.
1841+# This tag requires that the tag GENERATE_LATEX is set to YES.
1842+
1843+LATEX_EMOJI_DIRECTORY =
1844+
17141845 #---------------------------------------------------------------------------
17151846 # Configuration options related to the RTF output
17161847 #---------------------------------------------------------------------------
17171848
1718-# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The
1849+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
17191850 # RTF output is optimized for Word 97 and may not look too pretty with other RTF
17201851 # readers/editors.
17211852 # The default value is: NO.
@@ -1730,7 +1861,7 @@ GENERATE_RTF = NO
17301861
17311862 RTF_OUTPUT = rtf
17321863
1733-# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF
1864+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
17341865 # documents. This may be useful for small projects and may help to save some
17351866 # trees in general.
17361867 # The default value is: NO.
@@ -1750,28 +1881,38 @@ COMPACT_RTF = NO
17501881
17511882 RTF_HYPERLINKS = NO
17521883
1753-# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1754-# file, i.e. a series of assignments. You only have to provide replacements,
1755-# missing definitions are set to their default value.
1884+# Load stylesheet definitions from file. Syntax is similar to doxygen's
1885+# configuration file, i.e. a series of assignments. You only have to provide
1886+# replacements, missing definitions are set to their default value.
17561887 #
17571888 # See also section "Doxygen usage" for information on how to generate the
17581889 # default style sheet that doxygen normally uses.
17591890 # This tag requires that the tag GENERATE_RTF is set to YES.
17601891
1761-RTF_STYLESHEET_FILE =
1892+RTF_STYLESHEET_FILE =
17621893
17631894 # Set optional variables used in the generation of an RTF document. Syntax is
1764-# similar to doxygen's config file. A template extensions file can be generated
1765-# using doxygen -e rtf extensionFile.
1895+# similar to doxygen's configuration file. A template extensions file can be
1896+# generated using doxygen -e rtf extensionFile.
1897+# This tag requires that the tag GENERATE_RTF is set to YES.
1898+
1899+RTF_EXTENSIONS_FILE =
1900+
1901+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1902+# with syntax highlighting in the RTF output.
1903+#
1904+# Note that which sources are shown also depends on other settings such as
1905+# SOURCE_BROWSER.
1906+# The default value is: NO.
17661907 # This tag requires that the tag GENERATE_RTF is set to YES.
17671908
1768-RTF_EXTENSIONS_FILE =
1909+RTF_SOURCE_CODE = NO
17691910
17701911 #---------------------------------------------------------------------------
17711912 # Configuration options related to the man page output
17721913 #---------------------------------------------------------------------------
17731914
1774-# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for
1915+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
17751916 # classes and files.
17761917 # The default value is: NO.
17771918
@@ -1800,7 +1941,7 @@ MAN_EXTENSION = .3
18001941 # MAN_EXTENSION with the initial . removed.
18011942 # This tag requires that the tag GENERATE_MAN is set to YES.
18021943
1803-MAN_SUBDIR =
1944+MAN_SUBDIR =
18041945
18051946 # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
18061947 # will generate one additional man file for each entity documented in the real
@@ -1815,7 +1956,7 @@ MAN_LINKS = NO
18151956 # Configuration options related to the XML output
18161957 #---------------------------------------------------------------------------
18171958
1818-# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that
1959+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
18191960 # captures the structure of the code including all documentation.
18201961 # The default value is: NO.
18211962
@@ -1829,7 +1970,7 @@ GENERATE_XML = NO
18291970
18301971 XML_OUTPUT = xml
18311972
1832-# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
1973+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
18331974 # listings (including syntax highlighting and cross-referencing information) to
18341975 # the XML output. Note that enabling this will significantly increase the size
18351976 # of the XML output.
@@ -1838,11 +1979,18 @@ XML_OUTPUT = xml
18381979
18391980 XML_PROGRAMLISTING = YES
18401981
1982+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
1983+# namespace members in file scope as well, matching the HTML output.
1984+# The default value is: NO.
1985+# This tag requires that the tag GENERATE_XML is set to YES.
1986+
1987+XML_NS_MEMB_FILE_SCOPE = NO
1988+
18411989 #---------------------------------------------------------------------------
18421990 # Configuration options related to the DOCBOOK output
18431991 #---------------------------------------------------------------------------
18441992
1845-# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files
1993+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
18461994 # that can be used to generate PDF.
18471995 # The default value is: NO.
18481996
@@ -1856,14 +2004,23 @@ GENERATE_DOCBOOK = NO
18562004
18572005 DOCBOOK_OUTPUT = docbook
18582006
2007+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2008+# program listings (including syntax highlighting and cross-referencing
2009+# information) to the DOCBOOK output. Note that enabling this will significantly
2010+# increase the size of the DOCBOOK output.
2011+# The default value is: NO.
2012+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2013+
2014+DOCBOOK_PROGRAMLISTING = NO
2015+
18592016 #---------------------------------------------------------------------------
18602017 # Configuration options for the AutoGen Definitions output
18612018 #---------------------------------------------------------------------------
18622019
1863-# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen
1864-# Definitions (see http://autogen.sf.net) file that captures the structure of
1865-# the code including all documentation. Note that this feature is still
1866-# experimental and incomplete at the moment.
2020+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2021+# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2022+# the structure of the code including all documentation. Note that this feature
2023+# is still experimental and incomplete at the moment.
18672024 # The default value is: NO.
18682025
18692026 GENERATE_AUTOGEN_DEF = NO
@@ -1872,7 +2029,7 @@ GENERATE_AUTOGEN_DEF = NO
18722029 # Configuration options related to the Perl module output
18732030 #---------------------------------------------------------------------------
18742031
1875-# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module
2032+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
18762033 # file that captures the structure of the code including all documentation.
18772034 #
18782035 # Note that this feature is still experimental and incomplete at the moment.
@@ -1880,7 +2037,7 @@ GENERATE_AUTOGEN_DEF = NO
18802037
18812038 GENERATE_PERLMOD = NO
18822039
1883-# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary
2040+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
18842041 # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
18852042 # output from the Perl module output.
18862043 # The default value is: NO.
@@ -1888,9 +2045,9 @@ GENERATE_PERLMOD = NO
18882045
18892046 PERLMOD_LATEX = NO
18902047
1891-# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely
2048+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
18922049 # formatted so it can be parsed by a human reader. This is useful if you want to
1893-# understand what is going on. On the other hand, if this tag is set to NO the
2050+# understand what is going on. On the other hand, if this tag is set to NO, the
18942051 # size of the Perl module output will be much smaller and Perl will parse it
18952052 # just the same.
18962053 # The default value is: YES.
@@ -1904,20 +2061,20 @@ PERLMOD_PRETTY = YES
19042061 # overwrite each other's variables.
19052062 # This tag requires that the tag GENERATE_PERLMOD is set to YES.
19062063
1907-PERLMOD_MAKEVAR_PREFIX =
2064+PERLMOD_MAKEVAR_PREFIX =
19082065
19092066 #---------------------------------------------------------------------------
19102067 # Configuration options related to the preprocessor
19112068 #---------------------------------------------------------------------------
19122069
1913-# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all
2070+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
19142071 # C-preprocessor directives found in the sources and include files.
19152072 # The default value is: YES.
19162073
19172074 ENABLE_PREPROCESSING = YES
19182075
1919-# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names
1920-# in the source code. If set to NO only conditional compilation will be
2076+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2077+# in the source code. If set to NO, only conditional compilation will be
19212078 # performed. Macro expansion can be done in a controlled way by setting
19222079 # EXPAND_ONLY_PREDEF to YES.
19232080 # The default value is: NO.
@@ -1933,7 +2090,7 @@ MACRO_EXPANSION = NO
19332090
19342091 EXPAND_ONLY_PREDEF = NO
19352092
1936-# If the SEARCH_INCLUDES tag is set to YES the includes files in the
2093+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
19372094 # INCLUDE_PATH will be searched if a #include is found.
19382095 # The default value is: YES.
19392096 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
@@ -1945,7 +2102,7 @@ SEARCH_INCLUDES = YES
19452102 # preprocessor.
19462103 # This tag requires that the tag SEARCH_INCLUDES is set to YES.
19472104
1948-INCLUDE_PATH =
2105+INCLUDE_PATH =
19492106
19502107 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
19512108 # patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -1953,7 +2110,7 @@ INCLUDE_PATH =
19532110 # used.
19542111 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
19552112
1956-INCLUDE_FILE_PATTERNS =
2113+INCLUDE_FILE_PATTERNS =
19572114
19582115 # The PREDEFINED tag can be used to specify one or more macro names that are
19592116 # defined before the preprocessor is started (similar to the -D option of e.g.
@@ -1963,7 +2120,7 @@ INCLUDE_FILE_PATTERNS =
19632120 # recursively expanded use the := operator instead of the = operator.
19642121 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
19652122
1966-PREDEFINED =
2123+PREDEFINED =
19672124
19682125 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
19692126 # tag can be used to specify a list of macro names that should be expanded. The
@@ -1972,7 +2129,7 @@ PREDEFINED =
19722129 # definition found in the source code.
19732130 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
19742131
1975-EXPAND_AS_DEFINED =
2132+EXPAND_AS_DEFINED =
19762133
19772134 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
19782135 # remove all references to function-like macros that are alone on a line, have
@@ -2001,28 +2158,29 @@ SKIP_FUNCTION_MACROS = YES
20012158 # the path). If a tag file is not located in the directory in which doxygen is
20022159 # run, you must also specify the path to the tagfile here.
20032160
2004-TAGFILES =
2161+TAGFILES =
20052162
20062163 # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
20072164 # tag file that is based on the input files it reads. See section "Linking to
20082165 # external documentation" for more information about the usage of tag files.
20092166
2010-GENERATE_TAGFILE =
2167+GENERATE_TAGFILE =
20112168
2012-# If the ALLEXTERNALS tag is set to YES all external class will be listed in the
2013-# class index. If set to NO only the inherited external classes will be listed.
2169+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2170+# the class index. If set to NO, only the inherited external classes will be
2171+# listed.
20142172 # The default value is: NO.
20152173
20162174 ALLEXTERNALS = NO
20172175
2018-# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in
2019-# the modules index. If set to NO, only the current project's groups will be
2176+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2177+# in the modules index. If set to NO, only the current project's groups will be
20202178 # listed.
20212179 # The default value is: YES.
20222180
20232181 EXTERNAL_GROUPS = YES
20242182
2025-# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
2183+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
20262184 # the related pages index. If set to NO, only the current project's pages will
20272185 # be listed.
20282186 # The default value is: YES.
@@ -2039,14 +2197,14 @@ PERL_PATH = /usr/bin/perl
20392197 # Configuration options related to the dot tool
20402198 #---------------------------------------------------------------------------
20412199
2042-# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram
2200+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
20432201 # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
20442202 # NO turns the diagrams off. Note that this option also works with HAVE_DOT
20452203 # disabled, but it is recommended to install and use dot, since it yields more
20462204 # powerful graphs.
20472205 # The default value is: YES.
20482206
2049-CLASS_DIAGRAMS = NO
2207+CLASS_DIAGRAMS = YES
20502208
20512209 # You can define message sequence charts within doxygen comments using the \msc
20522210 # command. Doxygen will then run the mscgen tool (see:
@@ -2055,16 +2213,16 @@ CLASS_DIAGRAMS = NO
20552213 # the mscgen tool resides. If left empty the tool is assumed to be found in the
20562214 # default search path.
20572215
2058-MSCGEN_PATH =
2216+MSCGEN_PATH =
20592217
20602218 # You can include diagrams made with dia in doxygen documentation. Doxygen will
20612219 # then run dia to produce the diagram and insert it in the documentation. The
20622220 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
20632221 # If left empty dia is assumed to be found in the default search path.
20642222
2065-DIA_PATH =
2223+DIA_PATH =
20662224
2067-# If set to YES, the inheritance and collaboration graphs will hide inheritance
2225+# If set to YES the inheritance and collaboration graphs will hide inheritance
20682226 # and usage relations if the target is undocumented or is not a class.
20692227 # The default value is: YES.
20702228
@@ -2089,7 +2247,7 @@ HAVE_DOT = YES
20892247
20902248 DOT_NUM_THREADS = 0
20912249
2092-# When you want a differently looking font n the dot files that doxygen
2250+# When you want a differently looking font in the dot files that doxygen
20932251 # generates you can specify the font name using DOT_FONTNAME. You need to make
20942252 # sure dot is able to find the font, which can be done by putting it in a
20952253 # standard location or by setting the DOTFONTPATH environment variable or by
@@ -2111,7 +2269,7 @@ DOT_FONTSIZE = 10
21112269 # the path where dot can find it using this tag.
21122270 # This tag requires that the tag HAVE_DOT is set to YES.
21132271
2114-DOT_FONTPATH =
2272+DOT_FONTPATH =
21152273
21162274 # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
21172275 # each documented class showing the direct and indirect inheritance relations.
@@ -2137,7 +2295,7 @@ COLLABORATION_GRAPH = YES
21372295
21382296 GROUP_GRAPHS = YES
21392297
2140-# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
2298+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
21412299 # collaboration diagrams in a style similar to the OMG's Unified Modeling
21422300 # Language.
21432301 # The default value is: NO.
@@ -2189,7 +2347,8 @@ INCLUDED_BY_GRAPH = YES
21892347 #
21902348 # Note that enabling this option will significantly increase the time of a run.
21912349 # So in most cases it will be better to enable call graphs for selected
2192-# functions only using the \callgraph command.
2350+# functions only using the \callgraph command. Disabling a call graph can be
2351+# accomplished by means of the command \hidecallgraph.
21932352 # The default value is: NO.
21942353 # This tag requires that the tag HAVE_DOT is set to YES.
21952354
@@ -2200,7 +2359,8 @@ CALL_GRAPH = YES
22002359 #
22012360 # Note that enabling this option will significantly increase the time of a run.
22022361 # So in most cases it will be better to enable caller graphs for selected
2203-# functions only using the \callergraph command.
2362+# functions only using the \callergraph command. Disabling a caller graph can be
2363+# accomplished by means of the command \hidecallergraph.
22042364 # The default value is: NO.
22052365 # This tag requires that the tag HAVE_DOT is set to YES.
22062366
@@ -2223,11 +2383,15 @@ GRAPHICAL_HIERARCHY = YES
22232383 DIRECTORY_GRAPH = YES
22242384
22252385 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2226-# generated by dot.
2386+# generated by dot. For an explanation of the image formats see the section
2387+# output formats in the documentation of the dot tool (Graphviz (see:
2388+# http://www.graphviz.org/)).
22272389 # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
22282390 # to make the SVG files visible in IE 9+ (other browsers do not have this
22292391 # requirement).
2230-# Possible values are: png, jpg, gif and svg.
2392+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2393+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2394+# png:gdiplus:gdiplus.
22312395 # The default value is: png.
22322396 # This tag requires that the tag HAVE_DOT is set to YES.
22332397
@@ -2256,19 +2420,37 @@ DOT_PATH = "C:\/Program Files (x86)/Graphviz2.38/bin"
22562420 # command).
22572421 # This tag requires that the tag HAVE_DOT is set to YES.
22582422
2259-DOTFILE_DIRS =
2423+DOTFILE_DIRS =
22602424
22612425 # The MSCFILE_DIRS tag can be used to specify one or more directories that
22622426 # contain msc files that are included in the documentation (see the \mscfile
22632427 # command).
22642428
2265-MSCFILE_DIRS =
2429+MSCFILE_DIRS =
22662430
22672431 # The DIAFILE_DIRS tag can be used to specify one or more directories that
22682432 # contain dia files that are included in the documentation (see the \diafile
22692433 # command).
22702434
2271-DIAFILE_DIRS =
2435+DIAFILE_DIRS =
2436+
2437+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2438+# path where java can find the plantuml.jar file. If left blank, it is assumed
2439+# PlantUML is not used or called during a preprocessing step. Doxygen will
2440+# generate a warning when it encounters a \startuml command in this case and
2441+# will not generate output for the diagram.
2442+
2443+PLANTUML_JAR_PATH =
2444+
2445+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2446+# configuration file for plantuml.
2447+
2448+PLANTUML_CFG_FILE =
2449+
2450+# When using plantuml, the specified paths are searched for files specified by
2451+# the !include statement in a plantuml block.
2452+
2453+PLANTUML_INCLUDE_PATH =
22722454
22732455 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
22742456 # that will be shown in the graph. If the number of nodes in a graph becomes
@@ -2306,7 +2488,7 @@ MAX_DOT_GRAPH_DEPTH = 3
23062488
23072489 DOT_TRANSPARENT = NO
23082490
2309-# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
2491+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
23102492 # files in one run (i.e. multiple -o and -T options on the command line). This
23112493 # makes dot run faster, but since only newer versions of dot (>1.8.10) support
23122494 # this, this feature is disabled by default.
@@ -2323,7 +2505,7 @@ DOT_MULTI_TARGETS = NO
23232505
23242506 GENERATE_LEGEND = YES
23252507
2326-# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot
2508+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
23272509 # files that are used to generate the various graphs.
23282510 # The default value is: YES.
23292511 # This tag requires that the tag HAVE_DOT is set to YES.
Show on old repository browser