60 # in the documentation. The maximum height of the logo should not exceed 55 |
60 # in the documentation. The maximum height of the logo should not exceed 55 |
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
62 # the logo to the output directory. |
62 # the logo to the output directory. |
63 |
63 |
64 PROJECT_LOGO = ./uaplogo.png |
64 PROJECT_LOGO = ./uaplogo.png |
|
65 |
|
66 # With the PROJECT_ICON tag one can specify an icon that is included in the tabs |
|
67 # when the HTML document is shown. Doxygen will copy the logo to the output |
|
68 # directory. |
|
69 |
|
70 PROJECT_ICON = |
65 |
71 |
66 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
72 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
67 # into which the generated documentation will be written. If a relative path is |
73 # into which the generated documentation will be written. If a relative path is |
68 # entered, it will be relative to the location where doxygen was started. If |
74 # entered, it will be relative to the location where doxygen was started. If |
69 # left blank the current directory will be used. |
75 # left blank the current directory will be used. |
351 # Minimum value: 0, maximum value: 99, default value: 5. |
357 # Minimum value: 0, maximum value: 99, default value: 5. |
352 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
358 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
353 |
359 |
354 TOC_INCLUDE_HEADINGS = 5 |
360 TOC_INCLUDE_HEADINGS = 5 |
355 |
361 |
|
362 # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to |
|
363 # generate identifiers for the Markdown headings. Note: Every identifier is |
|
364 # unique. |
|
365 # Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a |
|
366 # sequence number starting at 0 and GITHUB use the lower case version of title |
|
367 # with any whitespace replaced by '-' and punctuation characters removed. |
|
368 # The default value is: DOXYGEN. |
|
369 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
|
370 |
|
371 MARKDOWN_ID_STYLE = DOXYGEN |
|
372 |
356 # When enabled doxygen tries to link words that correspond to documented |
373 # When enabled doxygen tries to link words that correspond to documented |
357 # classes, or namespaces to their corresponding documentation. Such a link can |
374 # classes, or namespaces to their corresponding documentation. Such a link can |
358 # be prevented in individual cases by putting a % sign in front of the word or |
375 # be prevented in individual cases by putting a % sign in front of the word or |
359 # globally by setting AUTOLINK_SUPPORT to NO. |
376 # globally by setting AUTOLINK_SUPPORT to NO. |
360 # The default value is: YES. |
377 # The default value is: YES. |
474 # encounter. Generating dot graphs in parallel is controlled by the |
491 # encounter. Generating dot graphs in parallel is controlled by the |
475 # DOT_NUM_THREADS setting. |
492 # DOT_NUM_THREADS setting. |
476 # Minimum value: 0, maximum value: 32, default value: 1. |
493 # Minimum value: 0, maximum value: 32, default value: 1. |
477 |
494 |
478 NUM_PROC_THREADS = 1 |
495 NUM_PROC_THREADS = 1 |
|
496 |
|
497 # If the TIMESTAMP tag is set different from NO then each generated page will |
|
498 # contain the date or date and time when the page was generated. Setting this to |
|
499 # NO can help when comparing the output of multiple runs. |
|
500 # Possible values are: YES, NO, DATETIME and DATE. |
|
501 # The default value is: NO. |
|
502 |
|
503 TIMESTAMP = YES |
479 |
504 |
480 #--------------------------------------------------------------------------- |
505 #--------------------------------------------------------------------------- |
481 # Build related configuration options |
506 # Build related configuration options |
482 #--------------------------------------------------------------------------- |
507 #--------------------------------------------------------------------------- |
483 |
508 |
860 |
885 |
861 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when |
886 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when |
862 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS |
887 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS |
863 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but |
888 # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but |
864 # at the end of the doxygen process doxygen will return with a non-zero status. |
889 # at the end of the doxygen process doxygen will return with a non-zero status. |
865 # Possible values are: NO, YES and FAIL_ON_WARNINGS. |
890 # If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves |
|
891 # like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not |
|
892 # write the warning messages in between other messages but write them at the end |
|
893 # of a run, in case a WARN_LOGFILE is defined the warning messages will be |
|
894 # besides being in the defined file also be shown at the end of a run, unless |
|
895 # the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case |
|
896 # the behavior will remain as with the setting FAIL_ON_WARNINGS. |
|
897 # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. |
866 # The default value is: NO. |
898 # The default value is: NO. |
867 |
899 |
868 WARN_AS_ERROR = NO |
900 WARN_AS_ERROR = NO |
869 |
901 |
870 # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
902 # The WARN_FORMAT tag determines the format of the warning messages that doxygen |
938 # read by doxygen. |
970 # read by doxygen. |
939 # |
971 # |
940 # Note the list of default checked file patterns might differ from the list of |
972 # Note the list of default checked file patterns might differ from the list of |
941 # default file extension mappings. |
973 # default file extension mappings. |
942 # |
974 # |
943 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
975 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm, |
944 # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
976 # *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, |
945 # *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, |
977 # *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, |
946 # *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C |
978 # *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to |
947 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, |
979 # be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, |
948 # *.vhdl, *.ucf, *.qsf and *.ice. |
980 # *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. |
949 |
981 |
950 FILE_PATTERNS = |
982 FILE_PATTERNS = |
951 |
983 |
952 # The RECURSIVE tag can be used to specify whether or not subdirectories should |
984 # The RECURSIVE tag can be used to specify whether or not subdirectories should |
953 # be searched for input files as well. |
985 # be searched for input files as well. |
983 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
1015 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
984 # (namespaces, classes, functions, etc.) that should be excluded from the |
1016 # (namespaces, classes, functions, etc.) that should be excluded from the |
985 # output. The symbol name can be a fully qualified name, a word, or if the |
1017 # output. The symbol name can be a fully qualified name, a word, or if the |
986 # wildcard * is used, a substring. Examples: ANamespace, AClass, |
1018 # wildcard * is used, a substring. Examples: ANamespace, AClass, |
987 # ANamespace::AClass, ANamespace::*Test |
1019 # ANamespace::AClass, ANamespace::*Test |
988 # |
|
989 # Note that the wildcards are matched against the file with absolute path, so to |
|
990 # exclude all test directories use the pattern */test/* |
|
991 |
1020 |
992 EXCLUDE_SYMBOLS = |
1021 EXCLUDE_SYMBOLS = |
993 |
1022 |
994 # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
1023 # The EXAMPLE_PATH tag can be used to specify one or more files or directories |
995 # that contain example code fragments that are included (see the \include |
1024 # that contain example code fragments that are included (see the \include |
1170 # specified. Set to NO to disable this. |
1200 # specified. Set to NO to disable this. |
1171 # See also: Section \class. |
1201 # See also: Section \class. |
1172 # The default value is: YES. |
1202 # The default value is: YES. |
1173 |
1203 |
1174 VERBATIM_HEADERS = YES |
1204 VERBATIM_HEADERS = YES |
1175 |
|
1176 # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
|
1177 # clang parser (see: |
|
1178 # http://clang.llvm.org/) for more accurate parsing at the cost of reduced |
|
1179 # performance. This can be particularly helpful with template rich C++ code for |
|
1180 # which doxygen's built-in parser lacks the necessary type information. |
|
1181 # Note: The availability of this option depends on whether or not doxygen was |
|
1182 # generated with the -Duse_libclang=ON option for CMake. |
|
1183 # The default value is: NO. |
|
1184 |
|
1185 CLANG_ASSISTED_PARSING = NO |
|
1186 |
|
1187 # If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS |
|
1188 # tag is set to YES then doxygen will add the directory of each input to the |
|
1189 # include path. |
|
1190 # The default value is: YES. |
|
1191 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
|
1192 |
|
1193 CLANG_ADD_INC_PATHS = YES |
|
1194 |
|
1195 # If clang assisted parsing is enabled you can provide the compiler with command |
|
1196 # line options that you would normally use when invoking the compiler. Note that |
|
1197 # the include paths will already be set by doxygen for the files and directories |
|
1198 # specified with INPUT and INCLUDE_PATH. |
|
1199 # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
|
1200 |
|
1201 CLANG_OPTIONS = |
|
1202 |
|
1203 # If clang assisted parsing is enabled you can provide the clang parser with the |
|
1204 # path to the directory containing a file called compile_commands.json. This |
|
1205 # file is the compilation database (see: |
|
1206 # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the |
|
1207 # options used when the source files were built. This is equivalent to |
|
1208 # specifying the -p option to a clang tool, such as clang-check. These options |
|
1209 # will then be passed to the parser. Any options specified with CLANG_OPTIONS |
|
1210 # will be added as well. |
|
1211 # Note: The availability of this option depends on whether or not doxygen was |
|
1212 # generated with the -Duse_libclang=ON option for CMake. |
|
1213 |
|
1214 CLANG_DATABASE_PATH = |
|
1215 |
1205 |
1216 #--------------------------------------------------------------------------- |
1206 #--------------------------------------------------------------------------- |
1217 # Configuration options related to the alphabetical class index |
1207 # Configuration options related to the alphabetical class index |
1218 #--------------------------------------------------------------------------- |
1208 #--------------------------------------------------------------------------- |
1219 |
1209 |
1368 # Minimum value: 40, maximum value: 240, default value: 80. |
1358 # Minimum value: 40, maximum value: 240, default value: 80. |
1369 # This tag requires that the tag GENERATE_HTML is set to YES. |
1359 # This tag requires that the tag GENERATE_HTML is set to YES. |
1370 |
1360 |
1371 HTML_COLORSTYLE_GAMMA = 80 |
1361 HTML_COLORSTYLE_GAMMA = 80 |
1372 |
1362 |
1373 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML |
|
1374 # page will contain the date and time when the page was generated. Setting this |
|
1375 # to YES can help to show when doxygen was last run and thus if the |
|
1376 # documentation is up to date. |
|
1377 # The default value is: NO. |
|
1378 # This tag requires that the tag GENERATE_HTML is set to YES. |
|
1379 |
|
1380 HTML_TIMESTAMP = YES |
|
1381 |
|
1382 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML |
1363 # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML |
1383 # documentation will contain a main index with vertical navigation menus that |
1364 # documentation will contain a main index with vertical navigation menus that |
1384 # are dynamically created via JavaScript. If disabled, the navigation index will |
1365 # are dynamically created via JavaScript. If disabled, the navigation index will |
1385 # consists of multiple levels of tabs that are statically embedded in every HTML |
1366 # consists of multiple levels of tabs that are statically embedded in every HTML |
1386 # page. Disable this option to support browsers that do not have JavaScript, |
1367 # page. Disable this option to support browsers that do not have JavaScript, |
1395 # page has loaded. |
1376 # page has loaded. |
1396 # The default value is: NO. |
1377 # The default value is: NO. |
1397 # This tag requires that the tag GENERATE_HTML is set to YES. |
1378 # This tag requires that the tag GENERATE_HTML is set to YES. |
1398 |
1379 |
1399 HTML_DYNAMIC_SECTIONS = NO |
1380 HTML_DYNAMIC_SECTIONS = NO |
|
1381 |
|
1382 # If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be |
|
1383 # dynamically folded and expanded in the generated HTML source code. |
|
1384 # The default value is: YES. |
|
1385 # This tag requires that the tag GENERATE_HTML is set to YES. |
|
1386 |
|
1387 HTML_CODE_FOLDING = YES |
|
1388 |
|
1389 # If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in |
|
1390 # the top right corner of code and text fragments that allows the user to copy |
|
1391 # its content to the clipboard. Note this only works if supported by the browser |
|
1392 # and the web page is served via a secure context (see: |
|
1393 # https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file: |
|
1394 # protocol. |
|
1395 # The default value is: YES. |
|
1396 # This tag requires that the tag GENERATE_HTML is set to YES. |
|
1397 |
|
1398 HTML_COPY_CLIPBOARD = YES |
|
1399 |
|
1400 # Doxygen stores a couple of settings persistently in the browser (via e.g. |
|
1401 # cookies). By default these settings apply to all HTML pages generated by |
|
1402 # doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store |
|
1403 # the settings under a project specific key, such that the user preferences will |
|
1404 # be stored separately. |
|
1405 # This tag requires that the tag GENERATE_HTML is set to YES. |
|
1406 |
|
1407 HTML_PROJECT_COOKIE = |
1400 |
1408 |
1401 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
1409 # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries |
1402 # shown in the various tree structured indices initially; the user can expand |
1410 # shown in the various tree structured indices initially; the user can expand |
1403 # and collapse entries dynamically later on. Doxygen will expand the tree to |
1411 # and collapse entries dynamically later on. Doxygen will expand the tree to |
1404 # such a level that at most the specified number of entries are visible (unless |
1412 # such a level that at most the specified number of entries are visible (unless |
1525 # the table of contents of the HTML help documentation and to the tree view. |
1533 # the table of contents of the HTML help documentation and to the tree view. |
1526 # The default value is: NO. |
1534 # The default value is: NO. |
1527 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1535 # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1528 |
1536 |
1529 TOC_EXPAND = NO |
1537 TOC_EXPAND = NO |
|
1538 |
|
1539 # The SITEMAP_URL tag is used to specify the full URL of the place where the |
|
1540 # generated documentation will be placed on the server by the user during the |
|
1541 # deployment of the documentation. The generated sitemap is called sitemap.xml |
|
1542 # and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL |
|
1543 # is specified no sitemap is generated. For information about the sitemap |
|
1544 # protocol see https://www.sitemaps.org |
|
1545 # This tag requires that the tag GENERATE_HTML is set to YES. |
|
1546 |
|
1547 SITEMAP_URL = |
1530 |
1548 |
1531 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
1549 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and |
1532 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
1550 # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that |
1533 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
1551 # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help |
1534 # (.qch) of the generated HTML documentation. |
1552 # (.qch) of the generated HTML documentation. |
2014 # The default value is: YES. |
2032 # The default value is: YES. |
2015 # This tag requires that the tag GENERATE_LATEX is set to YES. |
2033 # This tag requires that the tag GENERATE_LATEX is set to YES. |
2016 |
2034 |
2017 USE_PDFLATEX = YES |
2035 USE_PDFLATEX = YES |
2018 |
2036 |
2019 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode |
2037 # The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error. |
2020 # command to the generated LaTeX files. This will instruct LaTeX to keep running |
2038 # Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch |
2021 # if errors occur, instead of asking the user for help. |
2039 # mode nothing is printed on the terminal, errors are scrolled as if <return> is |
|
2040 # hit at every error; missing files that TeX tries to input or request from |
|
2041 # keyboard input (\read on a not open input stream) cause the job to abort, |
|
2042 # NON_STOP In nonstop mode the diagnostic message will appear on the terminal, |
|
2043 # but there is no possibility of user interaction just like in batch mode, |
|
2044 # SCROLL In scroll mode, TeX will stop only for missing files to input or if |
|
2045 # keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at |
|
2046 # each error, asking for user intervention. |
2022 # The default value is: NO. |
2047 # The default value is: NO. |
2023 # This tag requires that the tag GENERATE_LATEX is set to YES. |
2048 # This tag requires that the tag GENERATE_LATEX is set to YES. |
2024 |
2049 |
2025 LATEX_BATCHMODE = NO |
2050 LATEX_BATCHMODE = NO |
2026 |
2051 |
2036 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
2061 # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
2037 # The default value is: plain. |
2062 # The default value is: plain. |
2038 # This tag requires that the tag GENERATE_LATEX is set to YES. |
2063 # This tag requires that the tag GENERATE_LATEX is set to YES. |
2039 |
2064 |
2040 LATEX_BIB_STYLE = plain |
2065 LATEX_BIB_STYLE = plain |
2041 |
|
2042 # If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated |
|
2043 # page will contain the date and time when the page was generated. Setting this |
|
2044 # to NO can help when comparing the output of multiple runs. |
|
2045 # The default value is: NO. |
|
2046 # This tag requires that the tag GENERATE_LATEX is set to YES. |
|
2047 |
|
2048 LATEX_TIMESTAMP = NO |
|
2049 |
2066 |
2050 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) |
2067 # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) |
2051 # path from which the emoji images will be read. If a relative path is entered, |
2068 # path from which the emoji images will be read. If a relative path is entered, |
2052 # it will be relative to the LATEX_OUTPUT directory. If left blank the |
2069 # it will be relative to the LATEX_OUTPUT directory. If left blank the |
2053 # LATEX_OUTPUT directory will be used. |
2070 # LATEX_OUTPUT directory will be used. |
2210 #--------------------------------------------------------------------------- |
2227 #--------------------------------------------------------------------------- |
2211 # Configuration options for the AutoGen Definitions output |
2228 # Configuration options for the AutoGen Definitions output |
2212 #--------------------------------------------------------------------------- |
2229 #--------------------------------------------------------------------------- |
2213 |
2230 |
2214 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
2231 # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
2215 # AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures |
2232 # AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures |
2216 # the structure of the code including all documentation. Note that this feature |
2233 # the structure of the code including all documentation. Note that this feature |
2217 # is still experimental and incomplete at the moment. |
2234 # is still experimental and incomplete at the moment. |
2218 # The default value is: NO. |
2235 # The default value is: NO. |
2219 |
2236 |
2220 GENERATE_AUTOGEN_DEF = NO |
2237 GENERATE_AUTOGEN_DEF = NO |
|
2238 |
|
2239 #--------------------------------------------------------------------------- |
|
2240 # Configuration options related to Sqlite3 output |
|
2241 #--------------------------------------------------------------------------- |
|
2242 |
|
2243 # If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3 |
|
2244 # database with symbols found by doxygen stored in tables. |
|
2245 # The default value is: NO. |
|
2246 |
|
2247 GENERATE_SQLITE3 = NO |
|
2248 |
|
2249 # The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be |
|
2250 # put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put |
|
2251 # in front of it. |
|
2252 # The default directory is: sqlite3. |
|
2253 # This tag requires that the tag GENERATE_SQLITE3 is set to YES. |
|
2254 |
|
2255 SQLITE3_OUTPUT = sqlite3 |
|
2256 |
|
2257 # The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db |
|
2258 # database file will be recreated with each doxygen run. If set to NO, doxygen |
|
2259 # will warn if a database file is already found and not modify it. |
|
2260 # The default value is: YES. |
|
2261 # This tag requires that the tag GENERATE_SQLITE3 is set to YES. |
|
2262 |
|
2263 SQLITE3_RECREATE_DB = YES |
2221 |
2264 |
2222 #--------------------------------------------------------------------------- |
2265 #--------------------------------------------------------------------------- |
2223 # Configuration options related to the Perl module output |
2266 # Configuration options related to the Perl module output |
2224 #--------------------------------------------------------------------------- |
2267 #--------------------------------------------------------------------------- |
2225 |
2268 |
2359 # tag file that is based on the input files it reads. See section "Linking to |
2402 # tag file that is based on the input files it reads. See section "Linking to |
2360 # external documentation" for more information about the usage of tag files. |
2403 # external documentation" for more information about the usage of tag files. |
2361 |
2404 |
2362 GENERATE_TAGFILE = |
2405 GENERATE_TAGFILE = |
2363 |
2406 |
2364 # If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
2407 # If the ALLEXTERNALS tag is set to YES, all external classes and namespaces |
2365 # the class index. If set to NO, only the inherited external classes will be |
2408 # will be listed in the class and namespace index. If set to NO, only the |
2366 # listed. |
2409 # inherited external classes will be listed. |
2367 # The default value is: NO. |
2410 # The default value is: NO. |
2368 |
2411 |
2369 ALLEXTERNALS = NO |
2412 ALLEXTERNALS = NO |
2370 |
2413 |
2371 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
2414 # If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed |
2372 # in the modules index. If set to NO, only the current project's groups will be |
2415 # in the topic index. If set to NO, only the current project's groups will be |
2373 # listed. |
2416 # listed. |
2374 # The default value is: YES. |
2417 # The default value is: YES. |
2375 |
2418 |
2376 EXTERNAL_GROUPS = YES |
2419 EXTERNAL_GROUPS = YES |
2377 |
2420 |
2381 # The default value is: YES. |
2424 # The default value is: YES. |
2382 |
2425 |
2383 EXTERNAL_PAGES = YES |
2426 EXTERNAL_PAGES = YES |
2384 |
2427 |
2385 #--------------------------------------------------------------------------- |
2428 #--------------------------------------------------------------------------- |
2386 # Configuration options related to the dot tool |
2429 # Configuration options related to diagram generator tools |
2387 #--------------------------------------------------------------------------- |
2430 #--------------------------------------------------------------------------- |
2388 |
|
2389 # You can include diagrams made with dia in doxygen documentation. Doxygen will |
|
2390 # then run dia to produce the diagram and insert it in the documentation. The |
|
2391 # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
|
2392 # If left empty dia is assumed to be found in the default search path. |
|
2393 |
|
2394 DIA_PATH = |
|
2395 |
2431 |
2396 # If set to YES the inheritance and collaboration graphs will hide inheritance |
2432 # If set to YES the inheritance and collaboration graphs will hide inheritance |
2397 # and usage relations if the target is undocumented or is not a class. |
2433 # and usage relations if the target is undocumented or is not a class. |
2398 # The default value is: YES. |
2434 # The default value is: YES. |
2399 |
2435 |
2400 HIDE_UNDOC_RELATIONS = YES |
2436 HIDE_UNDOC_RELATIONS = YES |
2401 |
2437 |
2402 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
2438 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is |
2403 # available from the path. This tool is part of Graphviz (see: |
2439 # available from the path. This tool is part of Graphviz (see: |
2404 # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
2440 # https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
2405 # Bell Labs. The other options in this section have no effect if this option is |
2441 # Bell Labs. The other options in this section have no effect if this option is |
2406 # set to NO |
2442 # set to NO |
2407 # The default value is: NO. |
2443 # The default value is: NO. |
2408 |
2444 |
2409 HAVE_DOT = NO |
2445 HAVE_DOT = NO |
2452 # DOT_COMMON_ATTR and others dot attributes. |
2488 # DOT_COMMON_ATTR and others dot attributes. |
2453 # This tag requires that the tag HAVE_DOT is set to YES. |
2489 # This tag requires that the tag HAVE_DOT is set to YES. |
2454 |
2490 |
2455 DOT_FONTPATH = |
2491 DOT_FONTPATH = |
2456 |
2492 |
2457 # If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a |
2493 # If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will |
2458 # graph for each documented class showing the direct and indirect inheritance |
2494 # generate a graph for each documented class showing the direct and indirect |
2459 # relations. In case HAVE_DOT is set as well dot will be used to draw the graph, |
2495 # inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and |
2460 # otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set |
2496 # HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case |
2461 # to TEXT the direct and indirect inheritance relations will be shown as texts / |
2497 # the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the |
2462 # links. |
2498 # CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. |
2463 # Possible values are: NO, YES, TEXT and GRAPH. |
2499 # If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance |
|
2500 # relations will be shown as texts / links. Explicit enabling an inheritance |
|
2501 # graph or choosing a different representation for an inheritance graph of a |
|
2502 # specific class, can be accomplished by means of the command \inheritancegraph. |
|
2503 # Disabling an inheritance graph can be accomplished by means of the command |
|
2504 # \hideinheritancegraph. |
|
2505 # Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. |
2464 # The default value is: YES. |
2506 # The default value is: YES. |
2465 |
2507 |
2466 CLASS_GRAPH = YES |
2508 CLASS_GRAPH = YES |
2467 |
2509 |
2468 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
2510 # If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a |
2469 # graph for each documented class showing the direct and indirect implementation |
2511 # graph for each documented class showing the direct and indirect implementation |
2470 # dependencies (inheritance, containment, and class references variables) of the |
2512 # dependencies (inheritance, containment, and class references variables) of the |
2471 # class with other documented classes. |
2513 # class with other documented classes. Explicit enabling a collaboration graph, |
|
2514 # when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the |
|
2515 # command \collaborationgraph. Disabling a collaboration graph can be |
|
2516 # accomplished by means of the command \hidecollaborationgraph. |
2472 # The default value is: YES. |
2517 # The default value is: YES. |
2473 # This tag requires that the tag HAVE_DOT is set to YES. |
2518 # This tag requires that the tag HAVE_DOT is set to YES. |
2474 |
2519 |
2475 COLLABORATION_GRAPH = YES |
2520 COLLABORATION_GRAPH = YES |
2476 |
2521 |
2477 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
2522 # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for |
2478 # groups, showing the direct groups dependencies. See also the chapter Grouping |
2523 # groups, showing the direct groups dependencies. Explicit enabling a group |
2479 # in the manual. |
2524 # dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means |
|
2525 # of the command \groupgraph. Disabling a directory graph can be accomplished by |
|
2526 # means of the command \hidegroupgraph. See also the chapter Grouping in the |
|
2527 # manual. |
2480 # The default value is: YES. |
2528 # The default value is: YES. |
2481 # This tag requires that the tag HAVE_DOT is set to YES. |
2529 # This tag requires that the tag HAVE_DOT is set to YES. |
2482 |
2530 |
2483 GROUP_GRAPHS = YES |
2531 GROUP_GRAPHS = YES |
2484 |
2532 |
2516 |
2564 |
2517 DOT_UML_DETAILS = NO |
2565 DOT_UML_DETAILS = NO |
2518 |
2566 |
2519 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters |
2567 # The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters |
2520 # to display on a single line. If the actual line length exceeds this threshold |
2568 # to display on a single line. If the actual line length exceeds this threshold |
2521 # significantly it will wrapped across multiple lines. Some heuristics are apply |
2569 # significantly it will be wrapped across multiple lines. Some heuristics are |
2522 # to avoid ugly line breaks. |
2570 # applied to avoid ugly line breaks. |
2523 # Minimum value: 0, maximum value: 1000, default value: 17. |
2571 # Minimum value: 0, maximum value: 1000, default value: 17. |
2524 # This tag requires that the tag HAVE_DOT is set to YES. |
2572 # This tag requires that the tag HAVE_DOT is set to YES. |
2525 |
2573 |
2526 DOT_WRAP_THRESHOLD = 17 |
2574 DOT_WRAP_THRESHOLD = 17 |
2527 |
2575 |
2534 TEMPLATE_RELATIONS = NO |
2582 TEMPLATE_RELATIONS = NO |
2535 |
2583 |
2536 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
2584 # If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to |
2537 # YES then doxygen will generate a graph for each documented file showing the |
2585 # YES then doxygen will generate a graph for each documented file showing the |
2538 # direct and indirect include dependencies of the file with other documented |
2586 # direct and indirect include dependencies of the file with other documented |
2539 # files. |
2587 # files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO, |
|
2588 # can be accomplished by means of the command \includegraph. Disabling an |
|
2589 # include graph can be accomplished by means of the command \hideincludegraph. |
2540 # The default value is: YES. |
2590 # The default value is: YES. |
2541 # This tag requires that the tag HAVE_DOT is set to YES. |
2591 # This tag requires that the tag HAVE_DOT is set to YES. |
2542 |
2592 |
2543 INCLUDE_GRAPH = YES |
2593 INCLUDE_GRAPH = YES |
2544 |
2594 |
2545 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
2595 # If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are |
2546 # set to YES then doxygen will generate a graph for each documented file showing |
2596 # set to YES then doxygen will generate a graph for each documented file showing |
2547 # the direct and indirect include dependencies of the file with other documented |
2597 # the direct and indirect include dependencies of the file with other documented |
2548 # files. |
2598 # files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set |
|
2599 # to NO, can be accomplished by means of the command \includedbygraph. Disabling |
|
2600 # an included by graph can be accomplished by means of the command |
|
2601 # \hideincludedbygraph. |
2549 # The default value is: YES. |
2602 # The default value is: YES. |
2550 # This tag requires that the tag HAVE_DOT is set to YES. |
2603 # This tag requires that the tag HAVE_DOT is set to YES. |
2551 |
2604 |
2552 INCLUDED_BY_GRAPH = YES |
2605 INCLUDED_BY_GRAPH = YES |
2553 |
2606 |
2583 GRAPHICAL_HIERARCHY = YES |
2636 GRAPHICAL_HIERARCHY = YES |
2584 |
2637 |
2585 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
2638 # If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the |
2586 # dependencies a directory has on other directories in a graphical way. The |
2639 # dependencies a directory has on other directories in a graphical way. The |
2587 # dependency relations are determined by the #include relations between the |
2640 # dependency relations are determined by the #include relations between the |
2588 # files in the directories. |
2641 # files in the directories. Explicit enabling a directory graph, when |
|
2642 # DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command |
|
2643 # \directorygraph. Disabling a directory graph can be accomplished by means of |
|
2644 # the command \hidedirectorygraph. |
2589 # The default value is: YES. |
2645 # The default value is: YES. |
2590 # This tag requires that the tag HAVE_DOT is set to YES. |
2646 # This tag requires that the tag HAVE_DOT is set to YES. |
2591 |
2647 |
2592 DIRECTORY_GRAPH = YES |
2648 DIRECTORY_GRAPH = YES |
2593 |
2649 |
2599 DIR_GRAPH_MAX_DEPTH = 1 |
2655 DIR_GRAPH_MAX_DEPTH = 1 |
2600 |
2656 |
2601 # 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 |
2602 # 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 |
2603 # output formats in the documentation of the dot tool (Graphviz (see: |
2659 # output formats in the documentation of the dot tool (Graphviz (see: |
2604 # http://www.graphviz.org/)). |
2660 # https://www.graphviz.org/)). |
2605 # 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 |
2606 # 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 |
2607 # requirement). |
2663 # requirement). |
2608 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, |
2664 # Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, |
2609 # 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 |
2636 # command). |
2692 # command). |
2637 # This tag requires that the tag HAVE_DOT is set to YES. |
2693 # This tag requires that the tag HAVE_DOT is set to YES. |
2638 |
2694 |
2639 DOTFILE_DIRS = |
2695 DOTFILE_DIRS = |
2640 |
2696 |
2641 # The MSCFILE_DIRS tag can be used to specify one or more directories that |
2697 # You can include diagrams made with dia in doxygen documentation. Doxygen will |
2642 # contain msc files that are included in the documentation (see the \mscfile |
2698 # then run dia to produce the diagram and insert it in the documentation. The |
2643 # command). |
2699 # DIA_PATH tag allows you to specify the directory where the dia binary resides. |
2644 |
2700 # If left empty dia is assumed to be found in the default search path. |
2645 MSCFILE_DIRS = |
2701 |
|
2702 DIA_PATH = |
2646 |
2703 |
2647 # The DIAFILE_DIRS tag can be used to specify one or more directories that |
2704 # The DIAFILE_DIRS tag can be used to specify one or more directories that |
2648 # contain dia files that are included in the documentation (see the \diafile |
2705 # contain dia files that are included in the documentation (see the \diafile |
2649 # command). |
2706 # command). |
2650 |
2707 |
2717 # Note: This setting is not only used for dot files but also for msc temporary |
2774 # Note: This setting is not only used for dot files but also for msc temporary |
2718 # files. |
2775 # files. |
2719 # The default value is: YES. |
2776 # The default value is: YES. |
2720 |
2777 |
2721 DOT_CLEANUP = YES |
2778 DOT_CLEANUP = YES |
|
2779 |
|
2780 # You can define message sequence charts within doxygen comments using the \msc |
|
2781 # command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will |
|
2782 # use a built-in version of mscgen tool to produce the charts. Alternatively, |
|
2783 # the MSCGEN_TOOL tag can also specify the name an external tool. For instance, |
|
2784 # specifying prog as the value, doxygen will call the tool as prog -T |
|
2785 # <outfile_format> -o <outputfile> <inputfile>. The external tool should support |
|
2786 # output file formats "png", "eps", "svg", and "ismap". |
|
2787 |
|
2788 MSCGEN_TOOL = |
|
2789 |
|
2790 # The MSCFILE_DIRS tag can be used to specify one or more directories that |
|
2791 # contain msc files that are included in the documentation (see the \mscfile |
|
2792 # command). |
|
2793 |
|
2794 MSCFILE_DIRS = |