diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2022-12-04 16:47:17 +0900 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2022-12-04 16:47:17 +0900 |
commit | 292cefa2a12a78ae54fb56a3961452f439cb744f (patch) | |
tree | 14bcb29874ecab1301c624b375e0df088c03614f /doc/doxygen/gnunet.doxy | |
parent | cbe225ddce5627c59902cfdb9524dead675d19d0 (diff) | |
download | gnunet-292cefa2a12a78ae54fb56a3961452f439cb744f.tar.gz gnunet-292cefa2a12a78ae54fb56a3961452f439cb744f.zip |
BUILD: Attempt to disentable platform.h, gnunet_common.h and gnunet_private_config.h insanity
Diffstat (limited to 'doc/doxygen/gnunet.doxy')
-rw-r--r-- | doc/doxygen/gnunet.doxy | 640 |
1 files changed, 413 insertions, 227 deletions
diff --git a/doc/doxygen/gnunet.doxy b/doc/doxygen/gnunet.doxy index 3a7a9165f..3fe3b866a 100644 --- a/doc/doxygen/gnunet.doxy +++ b/doc/doxygen/gnunet.doxy | |||
@@ -1,4 +1,4 @@ | |||
1 | # Doxyfile 1.8.17 | 1 | # Doxyfile 1.9.5 |
2 | 2 | ||
3 | # This file describes the settings to be used by the documentation system | 3 | # This file describes the settings to be used by the documentation system |
4 | # doxygen (www.doxygen.org) for a project. | 4 | # doxygen (www.doxygen.org) for a project. |
@@ -12,6 +12,16 @@ | |||
12 | # For lists, items can also be appended using: | 12 | # For lists, items can also be appended using: |
13 | # TAG += value [value, ...] | 13 | # TAG += value [value, ...] |
14 | # Values that contain spaces should be placed between quotes (\" \"). | 14 | # Values that contain spaces should be placed between quotes (\" \"). |
15 | # | ||
16 | # Note: | ||
17 | # | ||
18 | # Use doxygen to compare the used configuration file with the template | ||
19 | # configuration file: | ||
20 | # doxygen -x [configFile] | ||
21 | # Use doxygen to compare the used configuration file with the template | ||
22 | # configuration file without replacing the environment variables or CMake type | ||
23 | # replacement variables: | ||
24 | # doxygen -x_noenv [configFile] | ||
15 | 25 | ||
16 | #--------------------------------------------------------------------------- | 26 | #--------------------------------------------------------------------------- |
17 | # Project related configuration options | 27 | # Project related configuration options |
@@ -38,7 +48,6 @@ PROJECT_NAME = GNUnet | |||
38 | # could be handy for archiving the generated documentation or if some version | 48 | # could be handy for archiving the generated documentation or if some version |
39 | # control system is used. | 49 | # control system is used. |
40 | 50 | ||
41 | # PROJECT_NUMBER = 0.16.x | ||
42 | @INCLUDE = "version.doxy" | 51 | @INCLUDE = "version.doxy" |
43 | 52 | ||
44 | # Using the PROJECT_BRIEF tag one can provide an optional one line description | 53 | # Using the PROJECT_BRIEF tag one can provide an optional one line description |
@@ -61,16 +70,28 @@ PROJECT_LOGO = gnunet-logo-no-text-small.png | |||
61 | 70 | ||
62 | OUTPUT_DIRECTORY = . | 71 | OUTPUT_DIRECTORY = . |
63 | 72 | ||
64 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- | 73 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 |
65 | # directories (in 2 levels) under the output directory of each output format and | 74 | # sub-directories (in 2 levels) under the output directory of each output format |
66 | # will distribute the generated files over these directories. Enabling this | 75 | # and will distribute the generated files over these directories. Enabling this |
67 | # option can be useful when feeding doxygen a huge amount of source files, where | 76 | # option can be useful when feeding doxygen a huge amount of source files, where |
68 | # putting all generated files in the same directory would otherwise causes | 77 | # putting all generated files in the same directory would otherwise causes |
69 | # performance problems for the file system. | 78 | # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to |
79 | # control the number of sub-directories. | ||
70 | # The default value is: NO. | 80 | # The default value is: NO. |
71 | 81 | ||
72 | CREATE_SUBDIRS = YES | 82 | CREATE_SUBDIRS = YES |
73 | 83 | ||
84 | # Controls the number of sub-directories that will be created when | ||
85 | # CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every | ||
86 | # level increment doubles the number of directories, resulting in 4096 | ||
87 | # directories at level 8 which is the default and also the maximum value. The | ||
88 | # sub-directories are organized in 2 levels, the first level always has a fixed | ||
89 | # numer of 16 directories. | ||
90 | # Minimum value: 0, maximum value: 8, default value: 8. | ||
91 | # This tag requires that the tag CREATE_SUBDIRS is set to YES. | ||
92 | |||
93 | CREATE_SUBDIRS_LEVEL = 8 | ||
94 | |||
74 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII | 95 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII |
75 | # characters to appear in the names of generated files. If set to NO, non-ASCII | 96 | # characters to appear in the names of generated files. If set to NO, non-ASCII |
76 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode | 97 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode |
@@ -82,26 +103,18 @@ ALLOW_UNICODE_NAMES = NO | |||
82 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all | 103 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all |
83 | # documentation generated by doxygen is written. Doxygen will use this | 104 | # documentation generated by doxygen is written. Doxygen will use this |
84 | # information to generate all constant output in the proper language. | 105 | # information to generate all constant output in the proper language. |
85 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, | 106 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, |
86 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), | 107 | # Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English |
87 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, | 108 | # (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, |
88 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), | 109 | # Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with |
89 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, | 110 | # English messages), Korean, Korean-en (Korean with English messages), Latvian, |
90 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, | 111 | # Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, |
91 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, | 112 | # Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, |
92 | # Ukrainian and Vietnamese. | 113 | # Swedish, Turkish, Ukrainian and Vietnamese. |
93 | # The default value is: English. | 114 | # The default value is: English. |
94 | 115 | ||
95 | OUTPUT_LANGUAGE = English | 116 | OUTPUT_LANGUAGE = English |
96 | 117 | ||
97 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all | ||
98 | # documentation generated by doxygen is written. Doxygen will use this | ||
99 | # information to generate all generated output in the proper direction. | ||
100 | # Possible values are: None, LTR, RTL and Context. | ||
101 | # The default value is: None. | ||
102 | |||
103 | OUTPUT_TEXT_DIRECTION = None | ||
104 | |||
105 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member | 118 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
106 | # descriptions after the members that are listed in the file and class | 119 | # descriptions after the members that are listed in the file and class |
107 | # documentation (similar to Javadoc). Set to NO to disable this. | 120 | # documentation (similar to Javadoc). Set to NO to disable this. |
@@ -230,6 +243,14 @@ QT_AUTOBRIEF = NO | |||
230 | 243 | ||
231 | MULTILINE_CPP_IS_BRIEF = NO | 244 | MULTILINE_CPP_IS_BRIEF = NO |
232 | 245 | ||
246 | # By default Python docstrings are displayed as preformatted text and doxygen's | ||
247 | # special commands cannot be used. By setting PYTHON_DOCSTRING to NO the | ||
248 | # doxygen's special commands can be used and the contents of the docstring | ||
249 | # documentation blocks is shown as doxygen documentation. | ||
250 | # The default value is: YES. | ||
251 | |||
252 | PYTHON_DOCSTRING = YES | ||
253 | |||
233 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the | 254 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
234 | # documentation from any documented member that it re-implements. | 255 | # documentation from any documented member that it re-implements. |
235 | # The default value is: YES. | 256 | # The default value is: YES. |
@@ -253,25 +274,19 @@ TAB_SIZE = 8 | |||
253 | # the documentation. An alias has the form: | 274 | # the documentation. An alias has the form: |
254 | # name=value | 275 | # name=value |
255 | # For example adding | 276 | # For example adding |
256 | # "sideeffect=@par Side Effects:\n" | 277 | # "sideeffect=@par Side Effects:^^" |
257 | # will allow you to put the command \sideeffect (or @sideeffect) in the | 278 | # will allow you to put the command \sideeffect (or @sideeffect) in the |
258 | # documentation, which will result in a user-defined paragraph with heading | 279 | # documentation, which will result in a user-defined paragraph with heading |
259 | # "Side Effects:". You can put \n's in the value part of an alias to insert | 280 | # "Side Effects:". Note that you cannot put \n's in the value part of an alias |
260 | # newlines (in the resulting output). You can put ^^ in the value part of an | 281 | # to insert newlines (in the resulting output). You can put ^^ in the value part |
261 | # alias to insert a newline as if a physical newline was in the original file. | 282 | # of an alias to insert a newline as if a physical newline was in the original |
262 | # When you need a literal { or } or , in the value part of an alias you have to | 283 | # file. When you need a literal { or } or , in the value part of an alias you |
263 | # escape them by means of a backslash (\), this can lead to conflicts with the | 284 | # have to escape them by means of a backslash (\), this can lead to conflicts |
264 | # commands \{ and \} for these it is advised to use the version @{ and @} or use | 285 | # with the commands \{ and \} for these it is advised to use the version @{ and |
265 | # a double escape (\\{ and \\}) | 286 | # @} or use a double escape (\\{ and \\}) |
266 | 287 | ||
267 | ALIASES = | 288 | ALIASES = |
268 | 289 | ||
269 | # This tag can be used to specify a number of word-keyword mappings (TCL only). | ||
270 | # A mapping has the form "name=value". For example adding "class=itcl::class" | ||
271 | # will allow you to use the command class in the itcl::class meaning. | ||
272 | |||
273 | TCL_SUBST = | ||
274 | |||
275 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources | 290 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
276 | # only. Doxygen will then generate output that is more tailored for C. For | 291 | # only. Doxygen will then generate output that is more tailored for C. For |
277 | # instance, some of the names that are used will be different. The list of all | 292 | # instance, some of the names that are used will be different. The list of all |
@@ -313,18 +328,21 @@ OPTIMIZE_OUTPUT_SLICE = NO | |||
313 | # extension. Doxygen has a built-in mapping, but you can override or extend it | 328 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
314 | # using this tag. The format is ext=language, where ext is a file extension, and | 329 | # using this tag. The format is ext=language, where ext is a file extension, and |
315 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, | 330 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, |
316 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, | 331 | # Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, |
317 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: | 332 | # VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
318 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser | 333 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
319 | # tries to guess whether the code is fixed or free formatted code, this is the | 334 | # tries to guess whether the code is fixed or free formatted code, this is the |
320 | # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat | 335 | # default for Fortran type files). For instance to make doxygen treat .inc files |
321 | # .inc files as Fortran files (default is PHP), and .f files as C (default is | 336 | # as Fortran files (default is PHP), and .f files as C (default is Fortran), |
322 | # Fortran), use: inc=Fortran f=C. | 337 | # use: inc=Fortran f=C. |
323 | # | 338 | # |
324 | # Note: For files without extension you can use no_extension as a placeholder. | 339 | # Note: For files without extension you can use no_extension as a placeholder. |
325 | # | 340 | # |
326 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise | 341 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
327 | # the files are not read by doxygen. | 342 | # the files are not read by doxygen. When specifying no_extension you should add |
343 | # * to the FILE_PATTERNS. | ||
344 | # | ||
345 | # Note see also the list of default file extension mappings. | ||
328 | 346 | ||
329 | EXTENSION_MAPPING = | 347 | EXTENSION_MAPPING = |
330 | 348 | ||
@@ -458,6 +476,19 @@ TYPEDEF_HIDES_STRUCT = NO | |||
458 | 476 | ||
459 | LOOKUP_CACHE_SIZE = 0 | 477 | LOOKUP_CACHE_SIZE = 0 |
460 | 478 | ||
479 | # The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use | ||
480 | # during processing. When set to 0 doxygen will based this on the number of | ||
481 | # cores available in the system. You can set it explicitly to a value larger | ||
482 | # than 0 to get more control over the balance between CPU load and processing | ||
483 | # speed. At this moment only the input processing can be done using multiple | ||
484 | # threads. Since this is still an experimental feature the default is set to 1, | ||
485 | # which effectively disables parallel processing. Please report any issues you | ||
486 | # encounter. Generating dot graphs in parallel is controlled by the | ||
487 | # DOT_NUM_THREADS setting. | ||
488 | # Minimum value: 0, maximum value: 32, default value: 1. | ||
489 | |||
490 | NUM_PROC_THREADS = 1 | ||
491 | |||
461 | #--------------------------------------------------------------------------- | 492 | #--------------------------------------------------------------------------- |
462 | # Build related configuration options | 493 | # Build related configuration options |
463 | #--------------------------------------------------------------------------- | 494 | #--------------------------------------------------------------------------- |
@@ -521,6 +552,13 @@ EXTRACT_LOCAL_METHODS = YES | |||
521 | 552 | ||
522 | EXTRACT_ANON_NSPACES = YES | 553 | EXTRACT_ANON_NSPACES = YES |
523 | 554 | ||
555 | # If this flag is set to YES, the name of an unnamed parameter in a declaration | ||
556 | # will be determined by the corresponding definition. By default unnamed | ||
557 | # parameters remain unnamed in the output. | ||
558 | # The default value is: YES. | ||
559 | |||
560 | RESOLVE_UNNAMED_PARAMS = YES | ||
561 | |||
524 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all | 562 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all |
525 | # undocumented members inside documented classes or files. If set to NO these | 563 | # undocumented members inside documented classes or files. If set to NO these |
526 | # members will be included in the various overviews, but no documentation | 564 | # members will be included in the various overviews, but no documentation |
@@ -558,12 +596,20 @@ HIDE_IN_BODY_DOCS = NO | |||
558 | 596 | ||
559 | INTERNAL_DOCS = YES | 597 | INTERNAL_DOCS = YES |
560 | 598 | ||
561 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file | 599 | # With the correct setting of option CASE_SENSE_NAMES doxygen will better be |
562 | # names in lower-case letters. If set to YES, upper-case letters are also | 600 | # able to match the capabilities of the underlying filesystem. In case the |
563 | # allowed. This is useful if you have classes or files whose names only differ | 601 | # filesystem is case sensitive (i.e. it supports files in the same directory |
564 | # in case and if your file system supports case sensitive file names. Windows | 602 | # whose names only differ in casing), the option must be set to YES to properly |
565 | # (including Cygwin) ands Mac users are advised to set this option to NO. | 603 | # deal with such files in case they appear in the input. For filesystems that |
566 | # The default value is: system dependent. | 604 | # are not case sensitive the option should be set to NO to properly deal with |
605 | # output files written for symbols that only differ in casing, such as for two | ||
606 | # classes, one named CLASS and the other named Class, and to also support | ||
607 | # references to files without having to specify the exact matching casing. On | ||
608 | # Windows (including Cygwin) and MacOS, users should typically set this option | ||
609 | # to NO, whereas on Linux or other Unix flavors it should typically be set to | ||
610 | # YES. | ||
611 | # Possible values are: SYSTEM, NO and YES. | ||
612 | # The default value is: SYSTEM. | ||
567 | 613 | ||
568 | CASE_SENSE_NAMES = YES | 614 | CASE_SENSE_NAMES = YES |
569 | 615 | ||
@@ -581,6 +627,12 @@ HIDE_SCOPE_NAMES = NO | |||
581 | 627 | ||
582 | HIDE_COMPOUND_REFERENCE= NO | 628 | HIDE_COMPOUND_REFERENCE= NO |
583 | 629 | ||
630 | # If the SHOW_HEADERFILE tag is set to YES then the documentation for a class | ||
631 | # will show which file needs to be included to use the class. | ||
632 | # The default value is: YES. | ||
633 | |||
634 | SHOW_HEADERFILE = YES | ||
635 | |||
584 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of | 636 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of |
585 | # the files that are included by a file in the documentation of that file. | 637 | # the files that are included by a file in the documentation of that file. |
586 | # The default value is: YES. | 638 | # The default value is: YES. |
@@ -738,7 +790,8 @@ FILE_VERSION_FILTER = | |||
738 | # output files in an output format independent way. To create the layout file | 790 | # output files in an output format independent way. To create the layout file |
739 | # that represents doxygen's defaults, run doxygen with the -l option. You can | 791 | # that represents doxygen's defaults, run doxygen with the -l option. You can |
740 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml | 792 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml |
741 | # will be used as the name of the layout file. | 793 | # will be used as the name of the layout file. See also section "Changing the |
794 | # layout of pages" for information. | ||
742 | # | 795 | # |
743 | # Note that if you run doxygen from a directory containing a file called | 796 | # Note that if you run doxygen from a directory containing a file called |
744 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE | 797 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
@@ -784,24 +837,35 @@ WARNINGS = YES | |||
784 | WARN_IF_UNDOCUMENTED = YES | 837 | WARN_IF_UNDOCUMENTED = YES |
785 | 838 | ||
786 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for | 839 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for |
787 | # potential errors in the documentation, such as not documenting some parameters | 840 | # potential errors in the documentation, such as documenting some parameters in |
788 | # in a documented function, or documenting parameters that don't exist or using | 841 | # a documented function twice, or documenting parameters that don't exist or |
789 | # markup commands wrongly. | 842 | # using markup commands wrongly. |
790 | # The default value is: YES. | 843 | # The default value is: YES. |
791 | 844 | ||
792 | WARN_IF_DOC_ERROR = YES | 845 | WARN_IF_DOC_ERROR = YES |
793 | 846 | ||
847 | # If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete | ||
848 | # function parameter documentation. If set to NO, doxygen will accept that some | ||
849 | # parameters have no documentation without warning. | ||
850 | # The default value is: YES. | ||
851 | |||
852 | WARN_IF_INCOMPLETE_DOC = YES | ||
853 | |||
794 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that | 854 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
795 | # are documented, but have no documentation for their parameters or return | 855 | # are documented, but have no documentation for their parameters or return |
796 | # value. If set to NO, doxygen will only warn about wrong or incomplete | 856 | # value. If set to NO, doxygen will only warn about wrong parameter |
797 | # parameter documentation, but not about the absence of documentation. If | 857 | # documentation, but not about the absence of documentation. If EXTRACT_ALL is |
798 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. | 858 | # set to YES then this flag will automatically be disabled. See also |
859 | # WARN_IF_INCOMPLETE_DOC | ||
799 | # The default value is: NO. | 860 | # The default value is: NO. |
800 | 861 | ||
801 | WARN_NO_PARAMDOC = YES | 862 | WARN_NO_PARAMDOC = YES |
802 | 863 | ||
803 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when | 864 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when |
804 | # a warning is encountered. | 865 | # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS |
866 | # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but | ||
867 | # at the end of the doxygen process doxygen will return with a non-zero status. | ||
868 | # Possible values are: NO, YES and FAIL_ON_WARNINGS. | ||
805 | # The default value is: NO. | 869 | # The default value is: NO. |
806 | 870 | ||
807 | WARN_AS_ERROR = NO | 871 | WARN_AS_ERROR = NO |
@@ -812,15 +876,29 @@ WARN_AS_ERROR = NO | |||
812 | # and the warning text. Optionally the format may contain $version, which will | 876 | # and the warning text. Optionally the format may contain $version, which will |
813 | # be replaced by the version of the file (if it could be obtained via | 877 | # be replaced by the version of the file (if it could be obtained via |
814 | # FILE_VERSION_FILTER) | 878 | # FILE_VERSION_FILTER) |
879 | # See also: WARN_LINE_FORMAT | ||
815 | # The default value is: $file:$line: $text. | 880 | # The default value is: $file:$line: $text. |
816 | 881 | ||
817 | WARN_FORMAT = "$file:$line: $text" | 882 | WARN_FORMAT = "$file:$line: $text" |
818 | 883 | ||
884 | # In the $text part of the WARN_FORMAT command it is possible that a reference | ||
885 | # to a more specific place is given. To make it easier to jump to this place | ||
886 | # (outside of doxygen) the user can define a custom "cut" / "paste" string. | ||
887 | # Example: | ||
888 | # WARN_LINE_FORMAT = "'vi $file +$line'" | ||
889 | # See also: WARN_FORMAT | ||
890 | # The default value is: at line $line of file $file. | ||
891 | |||
892 | WARN_LINE_FORMAT = "at line $line of file $file" | ||
893 | |||
819 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error | 894 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error |
820 | # messages should be written. If left blank the output is written to standard | 895 | # messages should be written. If left blank the output is written to standard |
821 | # error (stderr). | 896 | # error (stderr). In case the file specified cannot be opened for writing the |
897 | # warning and error messages are written to standard error. When as file - is | ||
898 | # specified the warning and error messages are written to standard output | ||
899 | # (stdout). | ||
822 | 900 | ||
823 | WARN_LOGFILE = "doxygen_warnings.log" | 901 | WARN_LOGFILE = doxygen_warnings.log |
824 | 902 | ||
825 | #--------------------------------------------------------------------------- | 903 | #--------------------------------------------------------------------------- |
826 | # Configuration options related to the input files | 904 | # Configuration options related to the input files |
@@ -839,12 +917,23 @@ INPUT = ../../src \ | |||
839 | # This tag can be used to specify the character encoding of the source files | 917 | # This tag can be used to specify the character encoding of the source files |
840 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses | 918 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
841 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv | 919 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
842 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of | 920 | # documentation (see: |
843 | # possible encodings. | 921 | # https://www.gnu.org/software/libiconv/) for the list of possible encodings. |
922 | # See also: INPUT_FILE_ENCODING | ||
844 | # The default value is: UTF-8. | 923 | # The default value is: UTF-8. |
845 | 924 | ||
846 | INPUT_ENCODING = UTF-8 | 925 | INPUT_ENCODING = UTF-8 |
847 | 926 | ||
927 | # This tag can be used to specify the character encoding of the source files | ||
928 | # that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify | ||
929 | # character encoding on a per file pattern basis. Doxygen will compare the file | ||
930 | # name with each pattern and apply the encoding instead of the default | ||
931 | # INPUT_ENCODING) if there is a match. The character encodings are a list of the | ||
932 | # form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding | ||
933 | # "INPUT_ENCODING" for further information on supported encodings. | ||
934 | |||
935 | INPUT_FILE_ENCODING = | ||
936 | |||
848 | # If the value of the INPUT tag contains directories, you can use the | 937 | # If the value of the INPUT tag contains directories, you can use the |
849 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and | 938 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and |
850 | # *.h) to filter out the source-files in the directories. | 939 | # *.h) to filter out the source-files in the directories. |
@@ -853,12 +942,14 @@ INPUT_ENCODING = UTF-8 | |||
853 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | 942 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
854 | # read by doxygen. | 943 | # read by doxygen. |
855 | # | 944 | # |
945 | # Note the list of default checked file patterns might differ from the list of | ||
946 | # default file extension mappings. | ||
947 | # | ||
856 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, | 948 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
857 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, | 949 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
858 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, | 950 | # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, |
859 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), | 951 | # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C |
860 | # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen | 952 | # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, |
861 | # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, | ||
862 | # *.vhdl, *.ucf, *.qsf and *.ice. | 953 | # *.vhdl, *.ucf, *.qsf and *.ice. |
863 | 954 | ||
864 | FILE_PATTERNS = *.c \ | 955 | FILE_PATTERNS = *.c \ |
@@ -950,7 +1041,7 @@ EXCLUDE_PATTERNS = */test_* \ | |||
950 | # (namespaces, classes, functions, etc.) that should be excluded from the | 1041 | # (namespaces, classes, functions, etc.) that should be excluded from the |
951 | # output. The symbol name can be a fully qualified name, a word, or if the | 1042 | # output. The symbol name can be a fully qualified name, a word, or if the |
952 | # wildcard * is used, a substring. Examples: ANamespace, AClass, | 1043 | # wildcard * is used, a substring. Examples: ANamespace, AClass, |
953 | # AClass::ANamespace, ANamespace::*Test | 1044 | # ANamespace::AClass, ANamespace::*Test |
954 | # | 1045 | # |
955 | # Note that the wildcards are matched against the file with absolute path, so to | 1046 | # Note that the wildcards are matched against the file with absolute path, so to |
956 | # exclude all test directories use the pattern */test/* | 1047 | # exclude all test directories use the pattern */test/* |
@@ -998,6 +1089,11 @@ IMAGE_PATH = | |||
998 | # code is scanned, but not when the output code is generated. If lines are added | 1089 | # code is scanned, but not when the output code is generated. If lines are added |
999 | # or removed, the anchors will not be placed correctly. | 1090 | # or removed, the anchors will not be placed correctly. |
1000 | # | 1091 | # |
1092 | # Note that doxygen will use the data processed and written to standard output | ||
1093 | # for further processing, therefore nothing else, like debug statements or used | ||
1094 | # commands (so in case of a Windows batch file always use @echo OFF), should be | ||
1095 | # written to standard output. | ||
1096 | # | ||
1001 | # Note that for custom extensions or not directly supported extensions you also | 1097 | # Note that for custom extensions or not directly supported extensions you also |
1002 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not | 1098 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not |
1003 | # properly processed by doxygen. | 1099 | # properly processed by doxygen. |
@@ -1039,6 +1135,15 @@ FILTER_SOURCE_PATTERNS = | |||
1039 | 1135 | ||
1040 | USE_MDFILE_AS_MAINPAGE = | 1136 | USE_MDFILE_AS_MAINPAGE = |
1041 | 1137 | ||
1138 | # The Fortran standard specifies that for fixed formatted Fortran code all | ||
1139 | # characters from position 72 are to be considered as comment. A common | ||
1140 | # extension is to allow longer lines before the automatic comment starts. The | ||
1141 | # setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can | ||
1142 | # be processed before the automatic comment starts. | ||
1143 | # Minimum value: 7, maximum value: 10000, default value: 72. | ||
1144 | |||
1145 | FORTRAN_COMMENT_AFTER = 72 | ||
1146 | |||
1042 | #--------------------------------------------------------------------------- | 1147 | #--------------------------------------------------------------------------- |
1043 | # Configuration options related to source browsing | 1148 | # Configuration options related to source browsing |
1044 | #--------------------------------------------------------------------------- | 1149 | #--------------------------------------------------------------------------- |
@@ -1126,16 +1231,24 @@ USE_HTAGS = NO | |||
1126 | VERBATIM_HEADERS = YES | 1231 | VERBATIM_HEADERS = YES |
1127 | 1232 | ||
1128 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the | 1233 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
1129 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the | 1234 | # clang parser (see: |
1130 | # cost of reduced performance. This can be particularly helpful with template | 1235 | # http://clang.llvm.org/) for more accurate parsing at the cost of reduced |
1131 | # rich C++ code for which doxygen's built-in parser lacks the necessary type | 1236 | # performance. This can be particularly helpful with template rich C++ code for |
1132 | # information. | 1237 | # which doxygen's built-in parser lacks the necessary type information. |
1133 | # Note: The availability of this option depends on whether or not doxygen was | 1238 | # Note: The availability of this option depends on whether or not doxygen was |
1134 | # generated with the -Duse_libclang=ON option for CMake. | 1239 | # generated with the -Duse_libclang=ON option for CMake. |
1135 | # The default value is: NO. | 1240 | # The default value is: NO. |
1136 | 1241 | ||
1137 | CLANG_ASSISTED_PARSING = NO | 1242 | CLANG_ASSISTED_PARSING = NO |
1138 | 1243 | ||
1244 | # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS | ||
1245 | # tag is set to YES then doxygen will add the directory of each input to the | ||
1246 | # include path. | ||
1247 | # The default value is: YES. | ||
1248 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. | ||
1249 | |||
1250 | CLANG_ADD_INC_PATHS = YES | ||
1251 | |||
1139 | # If clang assisted parsing is enabled you can provide the compiler with command | 1252 | # If clang assisted parsing is enabled you can provide the compiler with command |
1140 | # line options that you would normally use when invoking the compiler. Note that | 1253 | # line options that you would normally use when invoking the compiler. Note that |
1141 | # the include paths will already be set by doxygen for the files and directories | 1254 | # the include paths will already be set by doxygen for the files and directories |
@@ -1145,10 +1258,13 @@ CLANG_ASSISTED_PARSING = NO | |||
1145 | CLANG_OPTIONS = | 1258 | CLANG_OPTIONS = |
1146 | 1259 | ||
1147 | # If clang assisted parsing is enabled you can provide the clang parser with the | 1260 | # If clang assisted parsing is enabled you can provide the clang parser with the |
1148 | # path to the compilation database (see: | 1261 | # path to the directory containing a file called compile_commands.json. This |
1149 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files | 1262 | # file is the compilation database (see: |
1150 | # were built. This is equivalent to specifying the "-p" option to a clang tool, | 1263 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the |
1151 | # such as clang-check. These options will then be passed to the parser. | 1264 | # options used when the source files were built. This is equivalent to |
1265 | # specifying the -p option to a clang tool, such as clang-check. These options | ||
1266 | # will then be passed to the parser. Any options specified with CLANG_OPTIONS | ||
1267 | # will be added as well. | ||
1152 | # Note: The availability of this option depends on whether or not doxygen was | 1268 | # Note: The availability of this option depends on whether or not doxygen was |
1153 | # generated with the -Duse_libclang=ON option for CMake. | 1269 | # generated with the -Duse_libclang=ON option for CMake. |
1154 | 1270 | ||
@@ -1165,13 +1281,6 @@ CLANG_DATABASE_PATH = | |||
1165 | 1281 | ||
1166 | ALPHABETICAL_INDEX = YES | 1282 | ALPHABETICAL_INDEX = YES |
1167 | 1283 | ||
1168 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in | ||
1169 | # which the alphabetical index list will be split. | ||
1170 | # Minimum value: 1, maximum value: 20, default value: 5. | ||
1171 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. | ||
1172 | |||
1173 | COLS_IN_ALPHA_INDEX = 3 | ||
1174 | |||
1175 | # In case all classes in a project start with a common prefix, all classes will | 1284 | # In case all classes in a project start with a common prefix, all classes will |
1176 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag | 1285 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag |
1177 | # can be used to specify a prefix (or a list of prefixes) that should be ignored | 1286 | # can be used to specify a prefix (or a list of prefixes) that should be ignored |
@@ -1269,9 +1378,26 @@ HTML_EXTRA_STYLESHEET = | |||
1269 | 1378 | ||
1270 | HTML_EXTRA_FILES = | 1379 | HTML_EXTRA_FILES = |
1271 | 1380 | ||
1381 | # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output | ||
1382 | # should be rendered with a dark or light theme. Default setting AUTO_LIGHT | ||
1383 | # enables light output unless the user preference is dark output. Other options | ||
1384 | # are DARK to always use dark mode, LIGHT to always use light mode, AUTO_DARK to | ||
1385 | # default to dark mode unless the user prefers light mode, and TOGGLE to let the | ||
1386 | # user toggle between dark and light mode via a button. | ||
1387 | # Possible values are: LIGHT Always generate light output., DARK Always generate | ||
1388 | # dark output., AUTO_LIGHT Automatically set the mode according to the user | ||
1389 | # preference, use light mode if no preference is set (the default)., AUTO_DARK | ||
1390 | # Automatically set the mode according to the user preference, use dark mode if | ||
1391 | # no preference is set. and TOGGLE Allow to user to switch between light and | ||
1392 | # dark mode via a button.. | ||
1393 | # The default value is: AUTO_LIGHT. | ||
1394 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1395 | |||
1396 | HTML_COLORSTYLE = AUTO_LIGHT | ||
1397 | |||
1272 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen | 1398 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
1273 | # will adjust the colors in the style sheet and background images according to | 1399 | # will adjust the colors in the style sheet and background images according to |
1274 | # this color. Hue is specified as an angle on a colorwheel, see | 1400 | # this color. Hue is specified as an angle on a color-wheel, see |
1275 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value | 1401 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value |
1276 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 | 1402 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
1277 | # purple, and 360 is red again. | 1403 | # purple, and 360 is red again. |
@@ -1281,7 +1407,7 @@ HTML_EXTRA_FILES = | |||
1281 | HTML_COLORSTYLE_HUE = 220 | 1407 | HTML_COLORSTYLE_HUE = 220 |
1282 | 1408 | ||
1283 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors | 1409 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors |
1284 | # in the HTML output. For a value of 0 the output will use grayscales only. A | 1410 | # in the HTML output. For a value of 0 the output will use gray-scales only. A |
1285 | # value of 255 will produce the most vivid colors. | 1411 | # value of 255 will produce the most vivid colors. |
1286 | # Minimum value: 0, maximum value: 255, default value: 100. | 1412 | # Minimum value: 0, maximum value: 255, default value: 100. |
1287 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1413 | # This tag requires that the tag GENERATE_HTML is set to YES. |
@@ -1342,10 +1468,11 @@ HTML_INDEX_NUM_ENTRIES = 100 | |||
1342 | 1468 | ||
1343 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be | 1469 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be |
1344 | # generated that can be used as input for Apple's Xcode 3 integrated development | 1470 | # generated that can be used as input for Apple's Xcode 3 integrated development |
1345 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX | 1471 | # environment (see: |
1346 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a | 1472 | # https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To |
1347 | # Makefile in the HTML output directory. Running make will produce the docset in | 1473 | # create a documentation set, doxygen will generate a Makefile in the HTML |
1348 | # that directory and running make install will install the docset in | 1474 | # output directory. Running make will produce the docset in that directory and |
1475 | # running make install will install the docset in | ||
1349 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at | 1476 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
1350 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy | 1477 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy |
1351 | # genXcode/_index.html for more information. | 1478 | # genXcode/_index.html for more information. |
@@ -1362,6 +1489,13 @@ GENERATE_DOCSET = NO | |||
1362 | 1489 | ||
1363 | DOCSET_FEEDNAME = "GNUnet Source Documentation" | 1490 | DOCSET_FEEDNAME = "GNUnet Source Documentation" |
1364 | 1491 | ||
1492 | # This tag determines the URL of the docset feed. A documentation feed provides | ||
1493 | # an umbrella under which multiple documentation sets from a single provider | ||
1494 | # (such as a company or product suite) can be grouped. | ||
1495 | # This tag requires that the tag GENERATE_DOCSET is set to YES. | ||
1496 | |||
1497 | DOCSET_FEEDURL = | ||
1498 | |||
1365 | # This tag specifies a string that should uniquely identify the documentation | 1499 | # This tag specifies a string that should uniquely identify the documentation |
1366 | # set bundle. This should be a reverse domain-name style string, e.g. | 1500 | # set bundle. This should be a reverse domain-name style string, e.g. |
1367 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. | 1501 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. |
@@ -1387,8 +1521,12 @@ DOCSET_PUBLISHER_NAME = Publisher | |||
1387 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three | 1521 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
1388 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The | 1522 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
1389 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop | 1523 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
1390 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on | 1524 | # on Windows. In the beginning of 2021 Microsoft took the original page, with |
1391 | # Windows. | 1525 | # a.o. the download links, offline the HTML help workshop was already many years |
1526 | # in maintenance mode). You can download the HTML help workshop from the web | ||
1527 | # archives at Installation executable (see: | ||
1528 | # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo | ||
1529 | # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). | ||
1392 | # | 1530 | # |
1393 | # The HTML Help Workshop contains a compiler that can convert all HTML output | 1531 | # The HTML Help Workshop contains a compiler that can convert all HTML output |
1394 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML | 1532 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML |
@@ -1418,7 +1556,7 @@ CHM_FILE = | |||
1418 | HHC_LOCATION = | 1556 | HHC_LOCATION = |
1419 | 1557 | ||
1420 | # The GENERATE_CHI flag controls if a separate .chi index file is generated | 1558 | # The GENERATE_CHI flag controls if a separate .chi index file is generated |
1421 | # (YES) or that it should be included in the master .chm file (NO). | 1559 | # (YES) or that it should be included in the main .chm file (NO). |
1422 | # The default value is: NO. | 1560 | # The default value is: NO. |
1423 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. | 1561 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1424 | 1562 | ||
@@ -1463,7 +1601,8 @@ QCH_FILE = | |||
1463 | 1601 | ||
1464 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help | 1602 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
1465 | # Project output. For more information please see Qt Help Project / Namespace | 1603 | # Project output. For more information please see Qt Help Project / Namespace |
1466 | # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | 1604 | # (see: |
1605 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). | ||
1467 | # The default value is: org.doxygen.Project. | 1606 | # The default value is: org.doxygen.Project. |
1468 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1607 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1469 | 1608 | ||
@@ -1471,8 +1610,8 @@ QHP_NAMESPACE = org.doxygen.Project | |||
1471 | 1610 | ||
1472 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt | 1611 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
1473 | # Help Project output. For more information please see Qt Help Project / Virtual | 1612 | # Help Project output. For more information please see Qt Help Project / Virtual |
1474 | # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- | 1613 | # Folders (see: |
1475 | # folders). | 1614 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). |
1476 | # The default value is: doc. | 1615 | # The default value is: doc. |
1477 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1616 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1478 | 1617 | ||
@@ -1480,16 +1619,16 @@ QHP_VIRTUAL_FOLDER = doc | |||
1480 | 1619 | ||
1481 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom | 1620 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
1482 | # filter to add. For more information please see Qt Help Project / Custom | 1621 | # filter to add. For more information please see Qt Help Project / Custom |
1483 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- | 1622 | # Filters (see: |
1484 | # filters). | 1623 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). |
1485 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1624 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1486 | 1625 | ||
1487 | QHP_CUST_FILTER_NAME = | 1626 | QHP_CUST_FILTER_NAME = |
1488 | 1627 | ||
1489 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the | 1628 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
1490 | # custom filter to add. For more information please see Qt Help Project / Custom | 1629 | # custom filter to add. For more information please see Qt Help Project / Custom |
1491 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- | 1630 | # Filters (see: |
1492 | # filters). | 1631 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). |
1493 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1632 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1494 | 1633 | ||
1495 | QHP_CUST_FILTER_ATTRS = | 1634 | QHP_CUST_FILTER_ATTRS = |
@@ -1501,9 +1640,9 @@ QHP_CUST_FILTER_ATTRS = | |||
1501 | 1640 | ||
1502 | QHP_SECT_FILTER_ATTRS = | 1641 | QHP_SECT_FILTER_ATTRS = |
1503 | 1642 | ||
1504 | # The QHG_LOCATION tag can be used to specify the location of Qt's | 1643 | # The QHG_LOCATION tag can be used to specify the location (absolute path |
1505 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the | 1644 | # including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to |
1506 | # generated .qhp file. | 1645 | # run qhelpgenerator on the generated .qhp file. |
1507 | # This tag requires that the tag GENERATE_QHP is set to YES. | 1646 | # This tag requires that the tag GENERATE_QHP is set to YES. |
1508 | 1647 | ||
1509 | QHG_LOCATION = | 1648 | QHG_LOCATION = |
@@ -1546,16 +1685,28 @@ DISABLE_INDEX = YES | |||
1546 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required | 1685 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required |
1547 | # (i.e. any modern browser). Windows users are probably better off using the | 1686 | # (i.e. any modern browser). Windows users are probably better off using the |
1548 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can | 1687 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can |
1549 | # further fine-tune the look of the index. As an example, the default style | 1688 | # further fine tune the look of the index (see "Fine-tuning the output"). As an |
1550 | # sheet generated by doxygen has an example that shows how to put an image at | 1689 | # example, the default style sheet generated by doxygen has an example that |
1551 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has | 1690 | # shows how to put an image at the root of the tree instead of the PROJECT_NAME. |
1552 | # the same information as the tab index, you could consider setting | 1691 | # Since the tree basically has the same information as the tab index, you could |
1553 | # DISABLE_INDEX to YES when enabling this option. | 1692 | # consider setting DISABLE_INDEX to YES when enabling this option. |
1554 | # The default value is: NO. | 1693 | # The default value is: NO. |
1555 | # This tag requires that the tag GENERATE_HTML is set to YES. | 1694 | # This tag requires that the tag GENERATE_HTML is set to YES. |
1556 | 1695 | ||
1557 | GENERATE_TREEVIEW = YES | 1696 | GENERATE_TREEVIEW = YES |
1558 | 1697 | ||
1698 | # When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the | ||
1699 | # FULL_SIDEBAR option determines if the side bar is limited to only the treeview | ||
1700 | # area (value NO) or if it should extend to the full height of the window (value | ||
1701 | # YES). Setting this to YES gives a layout similar to | ||
1702 | # https://docs.readthedocs.io with more room for contents, but less room for the | ||
1703 | # project logo, title, and description. If either GENERATE_TREEVIEW or | ||
1704 | # DISABLE_INDEX is set to NO, this option has no effect. | ||
1705 | # The default value is: NO. | ||
1706 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1707 | |||
1708 | FULL_SIDEBAR = NO | ||
1709 | |||
1559 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that | 1710 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that |
1560 | # doxygen will group on one line in the generated HTML documentation. | 1711 | # doxygen will group on one line in the generated HTML documentation. |
1561 | # | 1712 | # |
@@ -1580,6 +1731,24 @@ TREEVIEW_WIDTH = 250 | |||
1580 | 1731 | ||
1581 | EXT_LINKS_IN_WINDOW = NO | 1732 | EXT_LINKS_IN_WINDOW = NO |
1582 | 1733 | ||
1734 | # If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email | ||
1735 | # addresses. | ||
1736 | # The default value is: YES. | ||
1737 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1738 | |||
1739 | OBFUSCATE_EMAILS = YES | ||
1740 | |||
1741 | # If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg | ||
1742 | # tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see | ||
1743 | # https://inkscape.org) to generate formulas as SVG images instead of PNGs for | ||
1744 | # the HTML output. These images will generally look nicer at scaled resolutions. | ||
1745 | # Possible values are: png (the default) and svg (looks nicer but requires the | ||
1746 | # pdf2svg or inkscape tool). | ||
1747 | # The default value is: png. | ||
1748 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1749 | |||
1750 | HTML_FORMULA_FORMAT = png | ||
1751 | |||
1583 | # Use this tag to change the font size of LaTeX formulas included as images in | 1752 | # Use this tag to change the font size of LaTeX formulas included as images in |
1584 | # the HTML documentation. When you change the font size after a successful | 1753 | # the HTML documentation. When you change the font size after a successful |
1585 | # doxygen run you need to manually remove any form_*.png images from the HTML | 1754 | # doxygen run you need to manually remove any form_*.png images from the HTML |
@@ -1589,17 +1758,6 @@ EXT_LINKS_IN_WINDOW = NO | |||
1589 | 1758 | ||
1590 | FORMULA_FONTSIZE = 10 | 1759 | FORMULA_FONTSIZE = 10 |
1591 | 1760 | ||
1592 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images | ||
1593 | # generated for formulas are transparent PNGs. Transparent PNGs are not | ||
1594 | # supported properly for IE 6.0, but are supported on all modern browsers. | ||
1595 | # | ||
1596 | # Note that when changing this option you need to delete any form_*.png files in | ||
1597 | # the HTML output directory before the changes have effect. | ||
1598 | # The default value is: YES. | ||
1599 | # This tag requires that the tag GENERATE_HTML is set to YES. | ||
1600 | |||
1601 | FORMULA_TRANSPARENT = YES | ||
1602 | |||
1603 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands | 1761 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands |
1604 | # to create new LaTeX commands to be used in formulas as building blocks. See | 1762 | # to create new LaTeX commands to be used in formulas as building blocks. See |
1605 | # the section "Including formulas" for details. | 1763 | # the section "Including formulas" for details. |
@@ -1617,11 +1775,29 @@ FORMULA_MACROFILE = | |||
1617 | 1775 | ||
1618 | USE_MATHJAX = NO | 1776 | USE_MATHJAX = NO |
1619 | 1777 | ||
1778 | # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. | ||
1779 | # Note that the different versions of MathJax have different requirements with | ||
1780 | # regards to the different settings, so it is possible that also other MathJax | ||
1781 | # settings have to be changed when switching between the different MathJax | ||
1782 | # versions. | ||
1783 | # Possible values are: MathJax_2 and MathJax_3. | ||
1784 | # The default value is: MathJax_2. | ||
1785 | # This tag requires that the tag USE_MATHJAX is set to YES. | ||
1786 | |||
1787 | MATHJAX_VERSION = MathJax_2 | ||
1788 | |||
1620 | # When MathJax is enabled you can set the default output format to be used for | 1789 | # When MathJax is enabled you can set the default output format to be used for |
1621 | # the MathJax output. See the MathJax site (see: | 1790 | # the MathJax output. For more details about the output format see MathJax |
1622 | # http://docs.mathjax.org/en/latest/output.html) for more details. | 1791 | # version 2 (see: |
1792 | # http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 | ||
1793 | # (see: | ||
1794 | # http://docs.mathjax.org/en/latest/web/components/output.html). | ||
1623 | # Possible values are: HTML-CSS (which is slower, but has the best | 1795 | # Possible values are: HTML-CSS (which is slower, but has the best |
1624 | # compatibility), NativeMML (i.e. MathML) and SVG. | 1796 | # compatibility. This is the name for Mathjax version 2, for MathJax version 3 |
1797 | # this will be translated into chtml), NativeMML (i.e. MathML. Only supported | ||
1798 | # for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This | ||
1799 | # is the name for Mathjax version 3, for MathJax version 2 this will be | ||
1800 | # translated into HTML-CSS) and SVG. | ||
1625 | # The default value is: HTML-CSS. | 1801 | # The default value is: HTML-CSS. |
1626 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1802 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1627 | 1803 | ||
@@ -1634,22 +1810,29 @@ MATHJAX_FORMAT = HTML-CSS | |||
1634 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax | 1810 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
1635 | # Content Delivery Network so you can quickly see the result without installing | 1811 | # Content Delivery Network so you can quickly see the result without installing |
1636 | # MathJax. However, it is strongly recommended to install a local copy of | 1812 | # MathJax. However, it is strongly recommended to install a local copy of |
1637 | # MathJax from https://www.mathjax.org before deployment. | 1813 | # MathJax from https://www.mathjax.org before deployment. The default value is: |
1638 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. | 1814 | # - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 |
1815 | # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 | ||
1639 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1816 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1640 | 1817 | ||
1641 | MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ | 1818 | MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ |
1642 | 1819 | ||
1643 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax | 1820 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax |
1644 | # extension names that should be enabled during MathJax rendering. For example | 1821 | # extension names that should be enabled during MathJax rendering. For example |
1822 | # for MathJax version 2 (see | ||
1823 | # https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): | ||
1645 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols | 1824 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
1825 | # For example for MathJax version 3 (see | ||
1826 | # http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): | ||
1827 | # MATHJAX_EXTENSIONS = ams | ||
1646 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1828 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1647 | 1829 | ||
1648 | MATHJAX_EXTENSIONS = | 1830 | MATHJAX_EXTENSIONS = |
1649 | 1831 | ||
1650 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces | 1832 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
1651 | # of code that will be used on startup of the MathJax code. See the MathJax site | 1833 | # of code that will be used on startup of the MathJax code. See the MathJax site |
1652 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an | 1834 | # (see: |
1835 | # http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an | ||
1653 | # example see the documentation. | 1836 | # example see the documentation. |
1654 | # This tag requires that the tag USE_MATHJAX is set to YES. | 1837 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1655 | 1838 | ||
@@ -1696,7 +1879,8 @@ SERVER_BASED_SEARCH = NO | |||
1696 | # | 1879 | # |
1697 | # Doxygen ships with an example indexer (doxyindexer) and search engine | 1880 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
1698 | # (doxysearch.cgi) which are based on the open source search engine library | 1881 | # (doxysearch.cgi) which are based on the open source search engine library |
1699 | # Xapian (see: https://xapian.org/). | 1882 | # Xapian (see: |
1883 | # https://xapian.org/). | ||
1700 | # | 1884 | # |
1701 | # See the section "External Indexing and Searching" for details. | 1885 | # See the section "External Indexing and Searching" for details. |
1702 | # The default value is: NO. | 1886 | # The default value is: NO. |
@@ -1709,8 +1893,9 @@ EXTERNAL_SEARCH = NO | |||
1709 | # | 1893 | # |
1710 | # Doxygen ships with an example indexer (doxyindexer) and search engine | 1894 | # Doxygen ships with an example indexer (doxyindexer) and search engine |
1711 | # (doxysearch.cgi) which are based on the open source search engine library | 1895 | # (doxysearch.cgi) which are based on the open source search engine library |
1712 | # Xapian (see: https://xapian.org/). See the section "External Indexing and | 1896 | # Xapian (see: |
1713 | # Searching" for details. | 1897 | # https://xapian.org/). See the section "External Indexing and Searching" for |
1898 | # details. | ||
1714 | # This tag requires that the tag SEARCHENGINE is set to YES. | 1899 | # This tag requires that the tag SEARCHENGINE is set to YES. |
1715 | 1900 | ||
1716 | SEARCHENGINE_URL = | 1901 | SEARCHENGINE_URL = |
@@ -1819,29 +2004,31 @@ PAPER_TYPE = a4 | |||
1819 | 2004 | ||
1820 | EXTRA_PACKAGES = | 2005 | EXTRA_PACKAGES = |
1821 | 2006 | ||
1822 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the | 2007 | # The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for |
1823 | # generated LaTeX document. The header should contain everything until the first | 2008 | # the generated LaTeX document. The header should contain everything until the |
1824 | # chapter. If it is left blank doxygen will generate a standard header. See | 2009 | # first chapter. If it is left blank doxygen will generate a standard header. It |
1825 | # section "Doxygen usage" for information on how to let doxygen write the | 2010 | # is highly recommended to start with a default header using |
1826 | # default header to a separate file. | 2011 | # doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty |
2012 | # and then modify the file new_header.tex. See also section "Doxygen usage" for | ||
2013 | # information on how to generate the default header that doxygen normally uses. | ||
1827 | # | 2014 | # |
1828 | # Note: Only use a user-defined header if you know what you are doing! The | 2015 | # Note: Only use a user-defined header if you know what you are doing! |
1829 | # following commands have a special meaning inside the header: $title, | 2016 | # Note: The header is subject to change so you typically have to regenerate the |
1830 | # $datetime, $date, $doxygenversion, $projectname, $projectnumber, | 2017 | # default header when upgrading to a newer version of doxygen. The following |
1831 | # $projectbrief, $projectlogo. Doxygen will replace $title with the empty | 2018 | # commands have a special meaning inside the header (and footer): For a |
1832 | # string, for the replacement values of the other commands the user is referred | 2019 | # description of the possible markers and block names see the documentation. |
1833 | # to HTML_HEADER. | ||
1834 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 2020 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1835 | 2021 | ||
1836 | LATEX_HEADER = | 2022 | LATEX_HEADER = |
1837 | 2023 | ||
1838 | # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the | 2024 | # The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for |
1839 | # generated LaTeX document. The footer should contain everything after the last | 2025 | # the generated LaTeX document. The footer should contain everything after the |
1840 | # chapter. If it is left blank doxygen will generate a standard footer. See | 2026 | # last chapter. If it is left blank doxygen will generate a standard footer. See |
1841 | # LATEX_HEADER for more information on how to generate a default footer and what | 2027 | # LATEX_HEADER for more information on how to generate a default footer and what |
1842 | # special commands can be used inside the footer. | 2028 | # special commands can be used inside the footer. See also section "Doxygen |
1843 | # | 2029 | # usage" for information on how to generate the default footer that doxygen |
1844 | # Note: Only use a user-defined footer if you know what you are doing! | 2030 | # normally uses. Note: Only use a user-defined footer if you know what you are |
2031 | # doing! | ||
1845 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 2032 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1846 | 2033 | ||
1847 | LATEX_FOOTER = | 2034 | LATEX_FOOTER = |
@@ -1874,9 +2061,11 @@ LATEX_EXTRA_FILES = | |||
1874 | 2061 | ||
1875 | PDF_HYPERLINKS = YES | 2062 | PDF_HYPERLINKS = YES |
1876 | 2063 | ||
1877 | # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate | 2064 | # If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as |
1878 | # the PDF file directly from the LaTeX files. Set this option to YES, to get a | 2065 | # specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX |
1879 | # higher quality PDF documentation. | 2066 | # files. Set this option to YES, to get a higher quality PDF documentation. |
2067 | # | ||
2068 | # See also section LATEX_CMD_NAME for selecting the engine. | ||
1880 | # The default value is: YES. | 2069 | # The default value is: YES. |
1881 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 2070 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1882 | 2071 | ||
@@ -1884,8 +2073,7 @@ USE_PDFLATEX = YES | |||
1884 | 2073 | ||
1885 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode | 2074 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
1886 | # command to the generated LaTeX files. This will instruct LaTeX to keep running | 2075 | # command to the generated LaTeX files. This will instruct LaTeX to keep running |
1887 | # if errors occur, instead of asking the user for help. This option is also used | 2076 | # if errors occur, instead of asking the user for help. |
1888 | # when generating formulas in HTML. | ||
1889 | # The default value is: NO. | 2077 | # The default value is: NO. |
1890 | # This tag requires that the tag GENERATE_LATEX is set to YES. | 2078 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1891 | 2079 | ||
@@ -1898,16 +2086,6 @@ LATEX_BATCHMODE = NO | |||
1898 | 2086 | ||
1899 | LATEX_HIDE_INDICES = NO | 2087 | LATEX_HIDE_INDICES = NO |
1900 | 2088 | ||
1901 | # If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source | ||
1902 | # code with syntax highlighting in the LaTeX 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. | ||
1907 | # This tag requires that the tag GENERATE_LATEX is set to YES. | ||
1908 | |||
1909 | LATEX_SOURCE_CODE = NO | ||
1910 | |||
1911 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the | 2089 | # The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
1912 | # bibliography, e.g. plainnat, or ieeetr. See | 2090 | # bibliography, e.g. plainnat, or ieeetr. See |
1913 | # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. | 2091 | # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
@@ -1988,16 +2166,6 @@ RTF_STYLESHEET_FILE = | |||
1988 | 2166 | ||
1989 | RTF_EXTENSIONS_FILE = | 2167 | RTF_EXTENSIONS_FILE = |
1990 | 2168 | ||
1991 | # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code | ||
1992 | # with syntax highlighting in the RTF output. | ||
1993 | # | ||
1994 | # Note that which sources are shown also depends on other settings such as | ||
1995 | # SOURCE_BROWSER. | ||
1996 | # The default value is: NO. | ||
1997 | # This tag requires that the tag GENERATE_RTF is set to YES. | ||
1998 | |||
1999 | RTF_SOURCE_CODE = NO | ||
2000 | |||
2001 | #--------------------------------------------------------------------------- | 2169 | #--------------------------------------------------------------------------- |
2002 | # Configuration options related to the man page output | 2170 | # Configuration options related to the man page output |
2003 | #--------------------------------------------------------------------------- | 2171 | #--------------------------------------------------------------------------- |
@@ -2094,15 +2262,6 @@ GENERATE_DOCBOOK = NO | |||
2094 | 2262 | ||
2095 | DOCBOOK_OUTPUT = docbook | 2263 | DOCBOOK_OUTPUT = docbook |
2096 | 2264 | ||
2097 | # If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the | ||
2098 | # program listings (including syntax highlighting and cross-referencing | ||
2099 | # information) to the DOCBOOK output. Note that enabling this will significantly | ||
2100 | # increase the size of the DOCBOOK output. | ||
2101 | # The default value is: NO. | ||
2102 | # This tag requires that the tag GENERATE_DOCBOOK is set to YES. | ||
2103 | |||
2104 | DOCBOOK_PROGRAMLISTING = NO | ||
2105 | |||
2106 | #--------------------------------------------------------------------------- | 2265 | #--------------------------------------------------------------------------- |
2107 | # Configuration options for the AutoGen Definitions output | 2266 | # Configuration options for the AutoGen Definitions output |
2108 | #--------------------------------------------------------------------------- | 2267 | #--------------------------------------------------------------------------- |
@@ -2189,7 +2348,8 @@ SEARCH_INCLUDES = YES | |||
2189 | 2348 | ||
2190 | # The INCLUDE_PATH tag can be used to specify one or more directories that | 2349 | # The INCLUDE_PATH tag can be used to specify one or more directories that |
2191 | # contain include files that are not input files but should be processed by the | 2350 | # contain include files that are not input files but should be processed by the |
2192 | # preprocessor. | 2351 | # preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of |
2352 | # RECURSIVE has no effect here. | ||
2193 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. | 2353 | # This tag requires that the tag SEARCH_INCLUDES is set to YES. |
2194 | 2354 | ||
2195 | INCLUDE_PATH = | 2355 | INCLUDE_PATH = |
@@ -2282,15 +2442,6 @@ EXTERNAL_PAGES = YES | |||
2282 | # Configuration options related to the dot tool | 2442 | # Configuration options related to the dot tool |
2283 | #--------------------------------------------------------------------------- | 2443 | #--------------------------------------------------------------------------- |
2284 | 2444 | ||
2285 | # If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram | ||
2286 | # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to | ||
2287 | # NO turns the diagrams off. Note that this option also works with HAVE_DOT | ||
2288 | # disabled, but it is recommended to install and use dot, since it yields more | ||
2289 | # powerful graphs. | ||
2290 | # The default value is: YES. | ||
2291 | |||
2292 | CLASS_DIAGRAMS = YES | ||
2293 | |||
2294 | # You can include diagrams made with dia in doxygen documentation. Doxygen will | 2445 | # You can include diagrams made with dia in doxygen documentation. Doxygen will |
2295 | # then run dia to produce the diagram and insert it in the documentation. The | 2446 | # then run dia to produce the diagram and insert it in the documentation. The |
2296 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. | 2447 | # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
@@ -2309,7 +2460,7 @@ HIDE_UNDOC_RELATIONS = YES | |||
2309 | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent | 2460 | # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
2310 | # Bell Labs. The other options in this section have no effect if this option is | 2461 | # Bell Labs. The other options in this section have no effect if this option is |
2311 | # set to NO | 2462 | # set to NO |
2312 | # The default value is: YES. | 2463 | # The default value is: NO. |
2313 | 2464 | ||
2314 | HAVE_DOT = YES | 2465 | HAVE_DOT = YES |
2315 | 2466 | ||
@@ -2323,35 +2474,50 @@ HAVE_DOT = YES | |||
2323 | 2474 | ||
2324 | DOT_NUM_THREADS = 0 | 2475 | DOT_NUM_THREADS = 0 |
2325 | 2476 | ||
2326 | # When you want a differently looking font in the dot files that doxygen | 2477 | # DOT_COMMON_ATTR is common attributes for nodes, edges and labels of |
2327 | # generates you can specify the font name using DOT_FONTNAME. You need to make | 2478 | # subgraphs. When you want a differently looking font in the dot files that |
2328 | # sure dot is able to find the font, which can be done by putting it in a | 2479 | # doxygen generates you can specify fontname, fontcolor and fontsize attributes. |
2329 | # standard location or by setting the DOTFONTPATH environment variable or by | 2480 | # For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node, |
2330 | # setting DOT_FONTPATH to the directory containing the font. | 2481 | # Edge and Graph Attributes specification</a> You need to make sure dot is able |
2331 | # The default value is: Helvetica. | 2482 | # to find the font, which can be done by putting it in a standard location or by |
2483 | # setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the | ||
2484 | # directory containing the font. Default graphviz fontsize is 14. | ||
2485 | # The default value is: fontname=Helvetica,fontsize=10. | ||
2486 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2487 | |||
2488 | DOT_COMMON_ATTR = "fontname=FreeSans,fontsize=10" | ||
2489 | |||
2490 | # DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can | ||
2491 | # add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a | ||
2492 | # href=https://graphviz.org/doc/info/arrows.html>Complete documentation about | ||
2493 | # arrows shapes.</a> | ||
2494 | # The default value is: labelfontname=Helvetica,labelfontsize=10. | ||
2332 | # This tag requires that the tag HAVE_DOT is set to YES. | 2495 | # This tag requires that the tag HAVE_DOT is set to YES. |
2333 | 2496 | ||
2334 | DOT_FONTNAME = FreeSans | 2497 | DOT_EDGE_ATTR = "labelfontname=FreeSans,labelfontsize=10" |
2335 | 2498 | ||
2336 | # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of | 2499 | # DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes |
2337 | # dot graphs. | 2500 | # around nodes set 'shape=plain' or 'shape=plaintext' <a |
2338 | # Minimum value: 4, maximum value: 24, default value: 10. | 2501 | # href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a> |
2502 | # The default value is: shape=box,height=0.2,width=0.4. | ||
2339 | # This tag requires that the tag HAVE_DOT is set to YES. | 2503 | # This tag requires that the tag HAVE_DOT is set to YES. |
2340 | 2504 | ||
2341 | DOT_FONTSIZE = 10 | 2505 | DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" |
2342 | 2506 | ||
2343 | # By default doxygen will tell dot to use the default font as specified with | 2507 | # You can set the path where dot can find font specified with fontname in |
2344 | # DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set | 2508 | # DOT_COMMON_ATTR and others dot attributes. |
2345 | # the path where dot can find it using this tag. | ||
2346 | # This tag requires that the tag HAVE_DOT is set to YES. | 2509 | # This tag requires that the tag HAVE_DOT is set to YES. |
2347 | 2510 | ||
2348 | DOT_FONTPATH = | 2511 | DOT_FONTPATH = |
2349 | 2512 | ||
2350 | # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for | 2513 | # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a |
2351 | # each documented class showing the direct and indirect inheritance relations. | 2514 | # graph for each documented class showing the direct and indirect inheritance |
2352 | # Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. | 2515 | # relations. In case HAVE_DOT is set as well dot will be used to draw the graph, |
2516 | # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set | ||
2517 | # to TEXT the direct and indirect inheritance relations will be shown as texts / | ||
2518 | # links. | ||
2519 | # Possible values are: NO, YES, TEXT and GRAPH. | ||
2353 | # The default value is: YES. | 2520 | # The default value is: YES. |
2354 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2355 | 2521 | ||
2356 | CLASS_GRAPH = YES | 2522 | CLASS_GRAPH = YES |
2357 | 2523 | ||
@@ -2365,7 +2531,8 @@ CLASS_GRAPH = YES | |||
2365 | COLLABORATION_GRAPH = YES | 2531 | COLLABORATION_GRAPH = YES |
2366 | 2532 | ||
2367 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for | 2533 | # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
2368 | # groups, showing the direct groups dependencies. | 2534 | # groups, showing the direct groups dependencies. See also the chapter Grouping |
2535 | # in the manual. | ||
2369 | # The default value is: YES. | 2536 | # The default value is: YES. |
2370 | # This tag requires that the tag HAVE_DOT is set to YES. | 2537 | # This tag requires that the tag HAVE_DOT is set to YES. |
2371 | 2538 | ||
@@ -2388,10 +2555,32 @@ UML_LOOK = NO | |||
2388 | # but if the number exceeds 15, the total amount of fields shown is limited to | 2555 | # but if the number exceeds 15, the total amount of fields shown is limited to |
2389 | # 10. | 2556 | # 10. |
2390 | # Minimum value: 0, maximum value: 100, default value: 10. | 2557 | # Minimum value: 0, maximum value: 100, default value: 10. |
2391 | # This tag requires that the tag HAVE_DOT is set to YES. | 2558 | # This tag requires that the tag UML_LOOK is set to YES. |
2392 | 2559 | ||
2393 | UML_LIMIT_NUM_FIELDS = 10 | 2560 | UML_LIMIT_NUM_FIELDS = 10 |
2394 | 2561 | ||
2562 | # If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and | ||
2563 | # methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS | ||
2564 | # tag is set to YES, doxygen will add type and arguments for attributes and | ||
2565 | # methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen | ||
2566 | # will not generate fields with class member information in the UML graphs. The | ||
2567 | # class diagrams will look similar to the default class diagrams but using UML | ||
2568 | # notation for the relationships. | ||
2569 | # Possible values are: NO, YES and NONE. | ||
2570 | # The default value is: NO. | ||
2571 | # This tag requires that the tag UML_LOOK is set to YES. | ||
2572 | |||
2573 | DOT_UML_DETAILS = NO | ||
2574 | |||
2575 | # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters | ||
2576 | # to display on a single line. If the actual line length exceeds this threshold | ||
2577 | # significantly it will wrapped across multiple lines. Some heuristics are apply | ||
2578 | # to avoid ugly line breaks. | ||
2579 | # Minimum value: 0, maximum value: 1000, default value: 17. | ||
2580 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2581 | |||
2582 | DOT_WRAP_THRESHOLD = 17 | ||
2583 | |||
2395 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and | 2584 | # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and |
2396 | # collaboration graphs will show the relations between templates and their | 2585 | # collaboration graphs will show the relations between templates and their |
2397 | # instances. | 2586 | # instances. |
@@ -2458,6 +2647,13 @@ GRAPHICAL_HIERARCHY = YES | |||
2458 | 2647 | ||
2459 | DIRECTORY_GRAPH = YES | 2648 | DIRECTORY_GRAPH = YES |
2460 | 2649 | ||
2650 | # The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels | ||
2651 | # of child directories generated in directory dependency graphs by dot. | ||
2652 | # Minimum value: 1, maximum value: 25, default value: 1. | ||
2653 | # This tag requires that the tag DIRECTORY_GRAPH is set to YES. | ||
2654 | |||
2655 | DIR_GRAPH_MAX_DEPTH = 1 | ||
2656 | |||
2461 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images | 2657 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images |
2462 | # generated by dot. For an explanation of the image formats see the section | 2658 | # generated by dot. For an explanation of the image formats see the section |
2463 | # output formats in the documentation of the dot tool (Graphviz (see: | 2659 | # output formats in the documentation of the dot tool (Graphviz (see: |
@@ -2465,9 +2661,7 @@ DIRECTORY_GRAPH = YES | |||
2465 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order | 2661 | # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
2466 | # to make the SVG files visible in IE 9+ (other browsers do not have this | 2662 | # to make the SVG files visible in IE 9+ (other browsers do not have this |
2467 | # requirement). | 2663 | # requirement). |
2468 | # Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, | 2664 | # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, |
2469 | # png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, | ||
2470 | # gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, | ||
2471 | # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and | 2665 | # png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and |
2472 | # png:gdiplus:gdiplus. | 2666 | # png:gdiplus:gdiplus. |
2473 | # The default value is: png. | 2667 | # The default value is: png. |
@@ -2513,10 +2707,10 @@ MSCFILE_DIRS = | |||
2513 | DIAFILE_DIRS = | 2707 | DIAFILE_DIRS = |
2514 | 2708 | ||
2515 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the | 2709 | # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
2516 | # path where java can find the plantuml.jar file. If left blank, it is assumed | 2710 | # path where java can find the plantuml.jar file or to the filename of jar file |
2517 | # PlantUML is not used or called during a preprocessing step. Doxygen will | 2711 | # to be used. If left blank, it is assumed PlantUML is not used or called during |
2518 | # generate a warning when it encounters a \startuml command in this case and | 2712 | # a preprocessing step. Doxygen will generate a warning when it encounters a |
2519 | # will not generate output for the diagram. | 2713 | # \startuml command in this case and will not generate output for the diagram. |
2520 | 2714 | ||
2521 | PLANTUML_JAR_PATH = | 2715 | PLANTUML_JAR_PATH = |
2522 | 2716 | ||
@@ -2554,18 +2748,6 @@ DOT_GRAPH_MAX_NODES = 50 | |||
2554 | 2748 | ||
2555 | MAX_DOT_GRAPH_DEPTH = 10 | 2749 | MAX_DOT_GRAPH_DEPTH = 10 |
2556 | 2750 | ||
2557 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent | ||
2558 | # background. This is disabled by default, because dot on Windows does not seem | ||
2559 | # to support this out of the box. | ||
2560 | # | ||
2561 | # Warning: Depending on the platform used, enabling this option may lead to | ||
2562 | # badly anti-aliased labels on the edges of a graph (i.e. they become hard to | ||
2563 | # read). | ||
2564 | # The default value is: NO. | ||
2565 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2566 | |||
2567 | DOT_TRANSPARENT = YES | ||
2568 | |||
2569 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output | 2751 | # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output |
2570 | # files in one run (i.e. multiple -o and -T options on the command line). This | 2752 | # files in one run (i.e. multiple -o and -T options on the command line). This |
2571 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support | 2753 | # makes dot run faster, but since only newer versions of dot (>1.8.10) support |
@@ -2578,14 +2760,18 @@ DOT_MULTI_TARGETS = YES | |||
2578 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page | 2760 | # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page |
2579 | # explaining the meaning of the various boxes and arrows in the dot generated | 2761 | # explaining the meaning of the various boxes and arrows in the dot generated |
2580 | # graphs. | 2762 | # graphs. |
2763 | # Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal | ||
2764 | # graphical representation for inheritance and collaboration diagrams is used. | ||
2581 | # The default value is: YES. | 2765 | # The default value is: YES. |
2582 | # This tag requires that the tag HAVE_DOT is set to YES. | 2766 | # This tag requires that the tag HAVE_DOT is set to YES. |
2583 | 2767 | ||
2584 | GENERATE_LEGEND = YES | 2768 | GENERATE_LEGEND = YES |
2585 | 2769 | ||
2586 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot | 2770 | # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate |
2587 | # files that are used to generate the various graphs. | 2771 | # files that are used to generate the various graphs. |
2772 | # | ||
2773 | # Note: This setting is not only used for dot files but also for msc temporary | ||
2774 | # files. | ||
2588 | # The default value is: YES. | 2775 | # The default value is: YES. |
2589 | # This tag requires that the tag HAVE_DOT is set to YES. | ||
2590 | 2776 | ||
2591 | DOT_CLEANUP = YES | 2777 | DOT_CLEANUP = YES |