| 1 |
< |
# Doxyfile 1.8.13 |
| 1 |
> |
# Doxyfile 1.8.17 |
| 2 |
|
|
| 3 |
|
# This file describes the settings to be used by the documentation system |
| 4 |
|
# doxygen (www.doxygen.org) for a project. |
| 17 |
|
# Project related configuration options |
| 18 |
|
#--------------------------------------------------------------------------- |
| 19 |
|
|
| 20 |
< |
# This tag specifies the encoding used for all characters in the config file |
| 21 |
< |
# that follow. The default is UTF-8 which is also the encoding used for all text |
| 22 |
< |
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
| 23 |
< |
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
| 24 |
< |
# for the list of possible encodings. |
| 20 |
> |
# This tag specifies the encoding used for all characters in the configuration |
| 21 |
> |
# file that follow. The default is UTF-8 which is also the encoding used for all |
| 22 |
> |
# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
| 23 |
> |
# iconv built into libc) for the transcoding. See |
| 24 |
> |
# https://www.gnu.org/software/libiconv/ for the list of possible encodings. |
| 25 |
|
# The default value is: UTF-8. |
| 26 |
|
|
| 27 |
|
DOXYFILE_ENCODING = UTF-8 |
| 44 |
|
# for a project that appears at the top of each page and should give viewer a |
| 45 |
|
# quick idea about the purpose of the project. Keep the description short. |
| 46 |
|
|
| 47 |
< |
PROJECT_BRIEF = |
| 47 |
> |
PROJECT_BRIEF = |
| 48 |
|
|
| 49 |
|
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included |
| 50 |
|
# in the documentation. The maximum height of the logo should not exceed 55 |
| 51 |
|
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy |
| 52 |
|
# the logo to the output directory. |
| 53 |
|
|
| 54 |
< |
PROJECT_LOGO = |
| 54 |
> |
PROJECT_LOGO = |
| 55 |
|
|
| 56 |
|
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path |
| 57 |
|
# into which the generated documentation will be written. If a relative path is |
| 93 |
|
|
| 94 |
|
OUTPUT_LANGUAGE = French |
| 95 |
|
|
| 96 |
+ |
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all |
| 97 |
+ |
# documentation generated by doxygen is written. Doxygen will use this |
| 98 |
+ |
# information to generate all generated output in the proper direction. |
| 99 |
+ |
# Possible values are: None, LTR, RTL and Context. |
| 100 |
+ |
# The default value is: None. |
| 101 |
+ |
|
| 102 |
+ |
OUTPUT_TEXT_DIRECTION = None |
| 103 |
+ |
|
| 104 |
|
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
| 105 |
|
# descriptions after the members that are listed in the file and class |
| 106 |
|
# documentation (similar to Javadoc). Set to NO to disable this. |
| 179 |
|
# specify the list of include paths that are normally passed to the compiler |
| 180 |
|
# using the -I flag. |
| 181 |
|
|
| 182 |
< |
STRIP_FROM_INC_PATH = |
| 182 |
> |
STRIP_FROM_INC_PATH = |
| 183 |
|
|
| 184 |
|
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but |
| 185 |
|
# less readable) file names. This can be useful is your file systems doesn't |
| 197 |
|
|
| 198 |
|
JAVADOC_AUTOBRIEF = NO |
| 199 |
|
|
| 200 |
+ |
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line |
| 201 |
+ |
# such as |
| 202 |
+ |
# /*************** |
| 203 |
+ |
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the |
| 204 |
+ |
# Javadoc-style will behave just like regular comments and it will not be |
| 205 |
+ |
# interpreted by doxygen. |
| 206 |
+ |
# The default value is: NO. |
| 207 |
+ |
|
| 208 |
+ |
JAVADOC_BANNER = NO |
| 209 |
+ |
|
| 210 |
|
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
| 211 |
|
# line (until the first dot) of a Qt-style comment as the brief description. If |
| 212 |
|
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
| 254 |
|
# will allow you to put the command \sideeffect (or @sideeffect) in the |
| 255 |
|
# documentation, which will result in a user-defined paragraph with heading |
| 256 |
|
# "Side Effects:". You can put \n's in the value part of an alias to insert |
| 257 |
< |
# newlines. |
| 257 |
> |
# newlines (in the resulting output). You can put ^^ in the value part of an |
| 258 |
> |
# alias to insert a newline as if a physical newline was in the original file. |
| 259 |
> |
# When you need a literal { or } or , in the value part of an alias you have to |
| 260 |
> |
# escape them by means of a backslash (\), this can lead to conflicts with the |
| 261 |
> |
# commands \{ and \} for these it is advised to use the version @{ and @} or use |
| 262 |
> |
# a double escape (\\{ and \\}) |
| 263 |
|
|
| 264 |
< |
ALIASES = |
| 264 |
> |
ALIASES = |
| 265 |
|
|
| 266 |
|
# This tag can be used to specify a number of word-keyword mappings (TCL only). |
| 267 |
|
# A mapping has the form "name=value". For example adding "class=itcl::class" |
| 268 |
|
# will allow you to use the command class in the itcl::class meaning. |
| 269 |
|
|
| 270 |
< |
TCL_SUBST = |
| 270 |
> |
TCL_SUBST = |
| 271 |
|
|
| 272 |
|
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
| 273 |
|
# only. Doxygen will then generate output that is more tailored for C. For |
| 297 |
|
|
| 298 |
|
OPTIMIZE_OUTPUT_VHDL = NO |
| 299 |
|
|
| 300 |
+ |
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice |
| 301 |
+ |
# sources only. Doxygen will then generate output that is more tailored for that |
| 302 |
+ |
# language. For instance, namespaces will be presented as modules, types will be |
| 303 |
+ |
# separated into more groups, etc. |
| 304 |
+ |
# The default value is: NO. |
| 305 |
+ |
|
| 306 |
+ |
OPTIMIZE_OUTPUT_SLICE = NO |
| 307 |
+ |
|
| 308 |
|
# Doxygen selects the parser to use depending on the extension of the files it |
| 309 |
|
# parses. With this tag you can assign which parser to use for a given |
| 310 |
|
# extension. Doxygen has a built-in mapping, but you can override or extend it |
| 311 |
|
# using this tag. The format is ext=language, where ext is a file extension, and |
| 312 |
< |
# language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
| 313 |
< |
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: |
| 314 |
< |
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: |
| 315 |
< |
# Fortran. In the later case the parser tries to guess whether the code is fixed |
| 316 |
< |
# or free formatted code, this is the default for Fortran type files), VHDL. For |
| 317 |
< |
# instance to make doxygen treat .inc files as Fortran files (default is PHP), |
| 318 |
< |
# and .f files as C (default is Fortran), use: inc=Fortran f=C. |
| 312 |
> |
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, |
| 313 |
> |
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, |
| 314 |
> |
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
| 315 |
> |
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
| 316 |
> |
# tries to guess whether the code is fixed or free formatted code, this is the |
| 317 |
> |
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat |
| 318 |
> |
# .inc files as Fortran files (default is PHP), and .f files as C (default is |
| 319 |
> |
# Fortran), use: inc=Fortran f=C. |
| 320 |
|
# |
| 321 |
|
# Note: For files without extension you can use no_extension as a placeholder. |
| 322 |
|
# |
| 323 |
|
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise |
| 324 |
|
# the files are not read by doxygen. |
| 325 |
|
|
| 326 |
< |
EXTENSION_MAPPING = |
| 326 |
> |
EXTENSION_MAPPING = |
| 327 |
|
|
| 328 |
|
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
| 329 |
|
# according to the Markdown format, which allows for more readable |
| 330 |
< |
# documentation. See http://daringfireball.net/projects/markdown/ for details. |
| 330 |
> |
# documentation. See https://daringfireball.net/projects/markdown/ for details. |
| 331 |
|
# The output of markdown processing is further processed by doxygen, so you can |
| 332 |
|
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
| 333 |
|
# case of backward compatibilities issues. |
| 339 |
|
# to that level are automatically included in the table of contents, even if |
| 340 |
|
# they do not have an id attribute. |
| 341 |
|
# Note: This feature currently applies only to Markdown headings. |
| 342 |
< |
# Minimum value: 0, maximum value: 99, default value: 0. |
| 342 |
> |
# Minimum value: 0, maximum value: 99, default value: 5. |
| 343 |
|
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
| 344 |
|
|
| 345 |
|
TOC_INCLUDE_HEADINGS = 0 |
| 369 |
|
CPP_CLI_SUPPORT = NO |
| 370 |
|
|
| 371 |
|
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
| 372 |
< |
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
| 372 |
> |
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen |
| 373 |
|
# will parse them like normal C++ but will assume all classes use public instead |
| 374 |
|
# of private inheritance when no explicit protection keyword is present. |
| 375 |
|
# The default value is: NO. |
| 475 |
|
|
| 476 |
|
EXTRACT_PRIVATE = YES |
| 477 |
|
|
| 478 |
+ |
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual |
| 479 |
+ |
# methods of a class will be included in the documentation. |
| 480 |
+ |
# The default value is: NO. |
| 481 |
+ |
|
| 482 |
+ |
EXTRACT_PRIV_VIRTUAL = NO |
| 483 |
+ |
|
| 484 |
|
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
| 485 |
|
# scope will be included in the documentation. |
| 486 |
|
# The default value is: NO. |
| 535 |
|
HIDE_UNDOC_CLASSES = NO |
| 536 |
|
|
| 537 |
|
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend |
| 538 |
< |
# (class|struct|union) declarations. If set to NO, these declarations will be |
| 539 |
< |
# included in the documentation. |
| 538 |
> |
# declarations. If set to NO, these declarations will be included in the |
| 539 |
> |
# documentation. |
| 540 |
|
# The default value is: NO. |
| 541 |
|
|
| 542 |
|
HIDE_FRIEND_COMPOUNDS = NO |
| 559 |
|
# names in lower-case letters. If set to YES, upper-case letters are also |
| 560 |
|
# allowed. This is useful if you have classes or files whose names only differ |
| 561 |
|
# in case and if your file system supports case sensitive file names. Windows |
| 562 |
< |
# and Mac users are advised to set this option to NO. |
| 562 |
> |
# (including Cygwin) ands Mac users are advised to set this option to NO. |
| 563 |
|
# The default value is: system dependent. |
| 564 |
|
|
| 565 |
|
CASE_SENSE_NAMES = NO |
| 686 |
|
# sections, marked by \if <section_label> ... \endif and \cond <section_label> |
| 687 |
|
# ... \endcond blocks. |
| 688 |
|
|
| 689 |
< |
ENABLED_SECTIONS = |
| 689 |
> |
ENABLED_SECTIONS = |
| 690 |
|
|
| 691 |
|
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the |
| 692 |
|
# initial value of a variable or macro / define can have for it to appear in the |
| 728 |
|
# by doxygen. Whatever the program writes to standard output is used as the file |
| 729 |
|
# version. For an example see the documentation. |
| 730 |
|
|
| 731 |
< |
FILE_VERSION_FILTER = |
| 731 |
> |
FILE_VERSION_FILTER = |
| 732 |
|
|
| 733 |
|
# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed |
| 734 |
|
# by doxygen. The layout file controls the global structure of the generated |
| 741 |
|
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE |
| 742 |
|
# tag is left empty. |
| 743 |
|
|
| 744 |
< |
LAYOUT_FILE = |
| 744 |
> |
LAYOUT_FILE = |
| 745 |
|
|
| 746 |
|
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
| 747 |
|
# the reference definitions. This must be a list of .bib files. The .bib |
| 748 |
|
# extension is automatically appended if omitted. This requires the bibtex tool |
| 749 |
< |
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
| 749 |
> |
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. |
| 750 |
|
# For LaTeX the style of the bibliography can be controlled using |
| 751 |
|
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
| 752 |
|
# search path. See also \cite for info how to create references. |
| 753 |
|
|
| 754 |
< |
CITE_BIB_FILES = |
| 754 |
> |
CITE_BIB_FILES = |
| 755 |
|
|
| 756 |
|
#--------------------------------------------------------------------------- |
| 757 |
|
# Configuration options related to warning and progress messages |
| 791 |
|
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
| 792 |
|
# are documented, but have no documentation for their parameters or return |
| 793 |
|
# value. If set to NO, doxygen will only warn about wrong or incomplete |
| 794 |
< |
# parameter documentation, but not about the absence of documentation. |
| 794 |
> |
# parameter documentation, but not about the absence of documentation. If |
| 795 |
> |
# EXTRACT_ALL is set to YES then this flag will automatically be disabled. |
| 796 |
|
# The default value is: NO. |
| 797 |
|
|
| 798 |
|
WARN_NO_PARAMDOC = NO |
| 817 |
|
# messages should be written. If left blank the output is written to standard |
| 818 |
|
# error (stderr). |
| 819 |
|
|
| 820 |
< |
WARN_LOGFILE = |
| 820 |
> |
WARN_LOGFILE = |
| 821 |
|
|
| 822 |
|
#--------------------------------------------------------------------------- |
| 823 |
|
# Configuration options related to the input files |
| 836 |
|
# This tag can be used to specify the character encoding of the source files |
| 837 |
|
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
| 838 |
|
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
| 839 |
< |
# documentation (see: http://www.gnu.org/software/libiconv) for the list of |
| 839 |
> |
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of |
| 840 |
|
# possible encodings. |
| 841 |
|
# The default value is: UTF-8. |
| 842 |
|
|
| 853 |
|
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
| 854 |
|
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
| 855 |
|
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, |
| 856 |
< |
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, |
| 857 |
< |
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. |
| 856 |
> |
# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), |
| 857 |
> |
# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen |
| 858 |
> |
# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, |
| 859 |
> |
# *.vhdl, *.ucf, *.qsf and *.ice. |
| 860 |
|
|
| 861 |
|
FILE_PATTERNS = *.c \ |
| 862 |
|
*.cc \ |
| 916 |
|
# Note that the wildcards are matched against the file with absolute path, so to |
| 917 |
|
# exclude all test directories for example use the pattern */test/* |
| 918 |
|
|
| 919 |
< |
EXCLUDE_PATTERNS = |
| 919 |
> |
EXCLUDE_PATTERNS = |
| 920 |
|
|
| 921 |
|
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names |
| 922 |
|
# (namespaces, classes, functions, etc.) that should be excluded from the |
| 927 |
|
# Note that the wildcards are matched against the file with absolute path, so to |
| 928 |
|
# exclude all test directories use the pattern */test/* |
| 929 |
|
|
| 930 |
< |
EXCLUDE_SYMBOLS = |
| 930 |
> |
EXCLUDE_SYMBOLS = |
| 931 |
|
|
| 932 |
|
# The EXAMPLE_PATH tag can be used to specify one or more files or directories |
| 933 |
|
# that contain example code fragments that are included (see the \include |
| 934 |
|
# command). |
| 935 |
|
|
| 936 |
< |
EXAMPLE_PATH = |
| 936 |
> |
EXAMPLE_PATH = |
| 937 |
|
|
| 938 |
|
# If the value of the EXAMPLE_PATH tag contains directories, you can use the |
| 939 |
|
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |
| 953 |
|
# that contain images that are to be included in the documentation (see the |
| 954 |
|
# \image command). |
| 955 |
|
|
| 956 |
< |
IMAGE_PATH = |
| 956 |
> |
IMAGE_PATH = |
| 957 |
|
|
| 958 |
|
# The INPUT_FILTER tag can be used to specify a program that doxygen should |
| 959 |
|
# invoke to filter for each input file. Doxygen will invoke the filter program |
| 974 |
|
# need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| 975 |
|
# properly processed by doxygen. |
| 976 |
|
|
| 977 |
< |
INPUT_FILTER = |
| 977 |
> |
INPUT_FILTER = |
| 978 |
|
|
| 979 |
|
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern |
| 980 |
|
# basis. Doxygen will compare the file name with each pattern and apply the |
| 987 |
|
# need to set EXTENSION_MAPPING for the extension otherwise the files are not |
| 988 |
|
# properly processed by doxygen. |
| 989 |
|
|
| 990 |
< |
FILTER_PATTERNS = |
| 990 |
> |
FILTER_PATTERNS = |
| 991 |
|
|
| 992 |
|
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using |
| 993 |
|
# INPUT_FILTER) will also be used to filter the input files that are used for |
| 1002 |
|
# *.ext= (so without naming a filter). |
| 1003 |
|
# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. |
| 1004 |
|
|
| 1005 |
< |
FILTER_SOURCE_PATTERNS = |
| 1005 |
> |
FILTER_SOURCE_PATTERNS = |
| 1006 |
|
|
| 1007 |
|
# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that |
| 1008 |
|
# is part of the input, its contents will be placed on the main page |
| 1009 |
|
# (index.html). This can be useful if you have a project on for instance GitHub |
| 1010 |
|
# and want to reuse the introduction page also for the doxygen output. |
| 1011 |
|
|
| 1012 |
< |
USE_MDFILE_AS_MAINPAGE = |
| 1012 |
> |
USE_MDFILE_AS_MAINPAGE = |
| 1013 |
|
|
| 1014 |
|
#--------------------------------------------------------------------------- |
| 1015 |
|
# Configuration options related to source browsing |
| 1038 |
|
STRIP_CODE_COMMENTS = YES |
| 1039 |
|
|
| 1040 |
|
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
| 1041 |
< |
# function all documented functions referencing it will be listed. |
| 1041 |
> |
# entity all documented functions referencing it will be listed. |
| 1042 |
|
# The default value is: NO. |
| 1043 |
|
|
| 1044 |
|
REFERENCED_BY_RELATION = YES |
| 1070 |
|
# If the USE_HTAGS tag is set to YES then the references to source code will |
| 1071 |
|
# point to the HTML generated by the htags(1) tool instead of doxygen built-in |
| 1072 |
|
# source browser. The htags tool is part of GNU's global source tagging system |
| 1073 |
< |
# (see http://www.gnu.org/software/global/global.html). You will need version |
| 1073 |
> |
# (see https://www.gnu.org/software/global/global.html). You will need version |
| 1074 |
|
# 4.8.6 or higher. |
| 1075 |
|
# |
| 1076 |
|
# To use it do the following: |
| 1077 |
|
# - Install the latest version of global |
| 1078 |
< |
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
| 1078 |
> |
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file |
| 1079 |
|
# - Make sure the INPUT points to the root of the source tree |
| 1080 |
|
# - Run doxygen as normal |
| 1081 |
|
# |
| 1103 |
|
# rich C++ code for which doxygen's built-in parser lacks the necessary type |
| 1104 |
|
# information. |
| 1105 |
|
# Note: The availability of this option depends on whether or not doxygen was |
| 1106 |
< |
# generated with the -Duse-libclang=ON option for CMake. |
| 1106 |
> |
# generated with the -Duse_libclang=ON option for CMake. |
| 1107 |
|
# The default value is: NO. |
| 1108 |
|
|
| 1109 |
|
CLANG_ASSISTED_PARSING = NO |
| 1114 |
|
# specified with INPUT and INCLUDE_PATH. |
| 1115 |
|
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
| 1116 |
|
|
| 1117 |
< |
CLANG_OPTIONS = |
| 1117 |
> |
CLANG_OPTIONS = |
| 1118 |
> |
|
| 1119 |
> |
# If clang assisted parsing is enabled you can provide the clang parser with the |
| 1120 |
> |
# path to the compilation database (see: |
| 1121 |
> |
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files |
| 1122 |
> |
# were built. This is equivalent to specifying the "-p" option to a clang tool, |
| 1123 |
> |
# such as clang-check. These options will then be passed to the parser. |
| 1124 |
> |
# Note: The availability of this option depends on whether or not doxygen was |
| 1125 |
> |
# generated with the -Duse_libclang=ON option for CMake. |
| 1126 |
> |
|
| 1127 |
> |
CLANG_DATABASE_PATH = |
| 1128 |
|
|
| 1129 |
|
#--------------------------------------------------------------------------- |
| 1130 |
|
# Configuration options related to the alphabetical class index |
| 1150 |
|
# while generating the index headers. |
| 1151 |
|
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. |
| 1152 |
|
|
| 1153 |
< |
IGNORE_PREFIX = |
| 1153 |
> |
IGNORE_PREFIX = |
| 1154 |
|
|
| 1155 |
|
#--------------------------------------------------------------------------- |
| 1156 |
|
# Configuration options related to the HTML output |
| 1194 |
|
# of the possible markers and block names see the documentation. |
| 1195 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1196 |
|
|
| 1197 |
< |
HTML_HEADER = |
| 1197 |
> |
HTML_HEADER = |
| 1198 |
|
|
| 1199 |
|
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each |
| 1200 |
|
# generated HTML page. If the tag is left blank doxygen will generate a standard |
| 1204 |
|
# that doxygen normally uses. |
| 1205 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1206 |
|
|
| 1207 |
< |
HTML_FOOTER = |
| 1207 |
> |
HTML_FOOTER = |
| 1208 |
|
|
| 1209 |
|
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style |
| 1210 |
|
# sheet that is used by each HTML page. It can be used to fine-tune the look of |
| 1216 |
|
# obsolete. |
| 1217 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1218 |
|
|
| 1219 |
< |
HTML_STYLESHEET = |
| 1219 |
> |
HTML_STYLESHEET = |
| 1220 |
|
|
| 1221 |
|
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
| 1222 |
|
# cascading style sheets that are included after the standard style sheets |
| 1229 |
|
# list). For an example see the documentation. |
| 1230 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1231 |
|
|
| 1232 |
< |
HTML_EXTRA_STYLESHEET = |
| 1232 |
> |
HTML_EXTRA_STYLESHEET = |
| 1233 |
|
|
| 1234 |
|
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or |
| 1235 |
|
# other source files which should be copied to the HTML output directory. Note |
| 1239 |
|
# files will be copied as-is; there are no commands or markers available. |
| 1240 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1241 |
|
|
| 1242 |
< |
HTML_EXTRA_FILES = |
| 1242 |
> |
HTML_EXTRA_FILES = |
| 1243 |
|
|
| 1244 |
|
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
| 1245 |
|
# will adjust the colors in the style sheet and background images according to |
| 1246 |
|
# this color. Hue is specified as an angle on a colorwheel, see |
| 1247 |
< |
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
| 1247 |
> |
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value |
| 1248 |
|
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
| 1249 |
|
# purple, and 360 is red again. |
| 1250 |
|
# Minimum value: 0, maximum value: 359, default value: 220. |
| 1280 |
|
|
| 1281 |
|
HTML_TIMESTAMP = YES |
| 1282 |
|
|
| 1283 |
+ |
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML |
| 1284 |
+ |
# documentation will contain a main index with vertical navigation menus that |
| 1285 |
+ |
# are dynamically created via JavaScript. If disabled, the navigation index will |
| 1286 |
+ |
# consists of multiple levels of tabs that are statically embedded in every HTML |
| 1287 |
+ |
# page. Disable this option to support browsers that do not have JavaScript, |
| 1288 |
+ |
# like the Qt help browser. |
| 1289 |
+ |
# The default value is: YES. |
| 1290 |
+ |
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1291 |
+ |
|
| 1292 |
+ |
HTML_DYNAMIC_MENUS = YES |
| 1293 |
+ |
|
| 1294 |
|
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
| 1295 |
|
# documentation will contain sections that can be hidden and shown after the |
| 1296 |
|
# page has loaded. |
| 1314 |
|
|
| 1315 |
|
# If the GENERATE_DOCSET tag is set to YES, additional index files will be |
| 1316 |
|
# generated that can be used as input for Apple's Xcode 3 integrated development |
| 1317 |
< |
# environment (see: http://developer.apple.com/tools/xcode/), introduced with |
| 1318 |
< |
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
| 1317 |
> |
# environment (see: https://developer.apple.com/xcode/), introduced with OSX |
| 1318 |
> |
# 10.5 (Leopard). To create a documentation set, doxygen will generate a |
| 1319 |
|
# Makefile in the HTML output directory. Running make will produce the docset in |
| 1320 |
|
# that directory and running make install will install the docset in |
| 1321 |
|
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
| 1322 |
< |
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
| 1323 |
< |
# for more information. |
| 1322 |
> |
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy |
| 1323 |
> |
# genXcode/_index.html for more information. |
| 1324 |
|
# The default value is: NO. |
| 1325 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1326 |
|
|
| 1359 |
|
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
| 1360 |
|
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
| 1361 |
|
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
| 1362 |
< |
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
| 1362 |
> |
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
| 1363 |
|
# Windows. |
| 1364 |
|
# |
| 1365 |
|
# The HTML Help Workshop contains a compiler that can convert all HTML output |
| 1379 |
|
# written to the html output directory. |
| 1380 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1381 |
|
|
| 1382 |
< |
CHM_FILE = |
| 1382 |
> |
CHM_FILE = |
| 1383 |
|
|
| 1384 |
|
# The HHC_LOCATION tag can be used to specify the location (absolute path |
| 1385 |
|
# including file name) of the HTML help compiler (hhc.exe). If non-empty, |
| 1387 |
|
# The file has to be specified with full path. |
| 1388 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1389 |
|
|
| 1390 |
< |
HHC_LOCATION = |
| 1390 |
> |
HHC_LOCATION = |
| 1391 |
|
|
| 1392 |
|
# The GENERATE_CHI flag controls if a separate .chi index file is generated |
| 1393 |
|
# (YES) or that it should be included in the master .chm file (NO). |
| 1400 |
|
# and project file content. |
| 1401 |
|
# This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
| 1402 |
|
|
| 1403 |
< |
CHM_INDEX_ENCODING = |
| 1403 |
> |
CHM_INDEX_ENCODING = |
| 1404 |
|
|
| 1405 |
|
# The BINARY_TOC flag controls whether a binary table of contents is generated |
| 1406 |
|
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it |
| 1431 |
|
# the HTML output folder. |
| 1432 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1433 |
|
|
| 1434 |
< |
QCH_FILE = |
| 1434 |
> |
QCH_FILE = |
| 1435 |
|
|
| 1436 |
|
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
| 1437 |
|
# Project output. For more information please see Qt Help Project / Namespace |
| 1438 |
< |
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
| 1438 |
> |
# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). |
| 1439 |
|
# The default value is: org.doxygen.Project. |
| 1440 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1441 |
|
|
| 1443 |
|
|
| 1444 |
|
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
| 1445 |
|
# Help Project output. For more information please see Qt Help Project / Virtual |
| 1446 |
< |
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
| 1446 |
> |
# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- |
| 1447 |
|
# folders). |
| 1448 |
|
# The default value is: doc. |
| 1449 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1452 |
|
|
| 1453 |
|
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
| 1454 |
|
# filter to add. For more information please see Qt Help Project / Custom |
| 1455 |
< |
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
| 1455 |
> |
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
| 1456 |
|
# filters). |
| 1457 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1458 |
|
|
| 1459 |
< |
QHP_CUST_FILTER_NAME = |
| 1459 |
> |
QHP_CUST_FILTER_NAME = |
| 1460 |
|
|
| 1461 |
|
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
| 1462 |
|
# custom filter to add. For more information please see Qt Help Project / Custom |
| 1463 |
< |
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
| 1463 |
> |
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
| 1464 |
|
# filters). |
| 1465 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1466 |
|
|
| 1467 |
< |
QHP_CUST_FILTER_ATTRS = |
| 1467 |
> |
QHP_CUST_FILTER_ATTRS = |
| 1468 |
|
|
| 1469 |
|
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
| 1470 |
|
# project's filter section matches. Qt Help Project / Filter Attributes (see: |
| 1471 |
< |
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
| 1471 |
> |
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). |
| 1472 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1473 |
|
|
| 1474 |
< |
QHP_SECT_FILTER_ATTRS = |
| 1474 |
> |
QHP_SECT_FILTER_ATTRS = |
| 1475 |
|
|
| 1476 |
|
# The QHG_LOCATION tag can be used to specify the location of Qt's |
| 1477 |
|
# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the |
| 1478 |
|
# generated .qhp file. |
| 1479 |
|
# This tag requires that the tag GENERATE_QHP is set to YES. |
| 1480 |
|
|
| 1481 |
< |
QHG_LOCATION = |
| 1481 |
> |
QHG_LOCATION = |
| 1482 |
|
|
| 1483 |
|
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be |
| 1484 |
|
# generated, together with the HTML files, they form an Eclipse help plugin. To |
| 1561 |
|
|
| 1562 |
|
FORMULA_FONTSIZE = 10 |
| 1563 |
|
|
| 1564 |
< |
# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
| 1564 |
> |
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images |
| 1565 |
|
# generated for formulas are transparent PNGs. Transparent PNGs are not |
| 1566 |
|
# supported properly for IE 6.0, but are supported on all modern browsers. |
| 1567 |
|
# |
| 1572 |
|
|
| 1573 |
|
FORMULA_TRANSPARENT = YES |
| 1574 |
|
|
| 1575 |
+ |
# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands |
| 1576 |
+ |
# to create new LaTeX commands to be used in formulas as building blocks. See |
| 1577 |
+ |
# the section "Including formulas" for details. |
| 1578 |
+ |
|
| 1579 |
+ |
FORMULA_MACROFILE = |
| 1580 |
+ |
|
| 1581 |
|
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
| 1582 |
< |
# http://www.mathjax.org) which uses client side Javascript for the rendering |
| 1582 |
> |
# https://www.mathjax.org) which uses client side JavaScript for the rendering |
| 1583 |
|
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
| 1584 |
|
# installed or if you want to formulas look prettier in the HTML output. When |
| 1585 |
|
# enabled you may also need to install MathJax separately and configure the path |
| 1606 |
|
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
| 1607 |
|
# Content Delivery Network so you can quickly see the result without installing |
| 1608 |
|
# MathJax. However, it is strongly recommended to install a local copy of |
| 1609 |
< |
# MathJax from http://www.mathjax.org before deployment. |
| 1610 |
< |
# The default value is: http://cdn.mathjax.org/mathjax/latest. |
| 1609 |
> |
# MathJax from https://www.mathjax.org before deployment. |
| 1610 |
> |
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. |
| 1611 |
|
# This tag requires that the tag USE_MATHJAX is set to YES. |
| 1612 |
|
|
| 1613 |
|
MATHJAX_RELPATH = http://www.mathjax.org/mathjax |
| 1617 |
|
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols |
| 1618 |
|
# This tag requires that the tag USE_MATHJAX is set to YES. |
| 1619 |
|
|
| 1620 |
< |
MATHJAX_EXTENSIONS = |
| 1620 |
> |
MATHJAX_EXTENSIONS = |
| 1621 |
|
|
| 1622 |
|
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces |
| 1623 |
|
# of code that will be used on startup of the MathJax code. See the MathJax site |
| 1625 |
|
# example see the documentation. |
| 1626 |
|
# This tag requires that the tag USE_MATHJAX is set to YES. |
| 1627 |
|
|
| 1628 |
< |
MATHJAX_CODEFILE = |
| 1628 |
> |
MATHJAX_CODEFILE = |
| 1629 |
|
|
| 1630 |
|
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for |
| 1631 |
|
# the HTML output. The underlying search engine uses javascript and DHTML and |
| 1649 |
|
SEARCHENGINE = YES |
| 1650 |
|
|
| 1651 |
|
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be |
| 1652 |
< |
# implemented using a web server instead of a web client using Javascript. There |
| 1652 |
> |
# implemented using a web server instead of a web client using JavaScript. There |
| 1653 |
|
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH |
| 1654 |
|
# setting. When disabled, doxygen will generate a PHP script for searching and |
| 1655 |
|
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing |
| 1668 |
|
# |
| 1669 |
|
# Doxygen ships with an example indexer (doxyindexer) and search engine |
| 1670 |
|
# (doxysearch.cgi) which are based on the open source search engine library |
| 1671 |
< |
# Xapian (see: http://xapian.org/). |
| 1671 |
> |
# Xapian (see: https://xapian.org/). |
| 1672 |
|
# |
| 1673 |
|
# See the section "External Indexing and Searching" for details. |
| 1674 |
|
# The default value is: NO. |
| 1681 |
|
# |
| 1682 |
|
# Doxygen ships with an example indexer (doxyindexer) and search engine |
| 1683 |
|
# (doxysearch.cgi) which are based on the open source search engine library |
| 1684 |
< |
# Xapian (see: http://xapian.org/). See the section "External Indexing and |
| 1684 |
> |
# Xapian (see: https://xapian.org/). See the section "External Indexing and |
| 1685 |
|
# Searching" for details. |
| 1686 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
| 1687 |
|
|
| 1688 |
< |
SEARCHENGINE_URL = |
| 1688 |
> |
SEARCHENGINE_URL = |
| 1689 |
|
|
| 1690 |
|
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed |
| 1691 |
|
# search data is written to a file for indexing by an external tool. With the |
| 1701 |
|
# projects and redirect the results back to the right project. |
| 1702 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
| 1703 |
|
|
| 1704 |
< |
EXTERNAL_SEARCH_ID = |
| 1704 |
> |
EXTERNAL_SEARCH_ID = |
| 1705 |
|
|
| 1706 |
|
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen |
| 1707 |
|
# projects other than the one defined by this configuration file, but that are |
| 1711 |
|
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... |
| 1712 |
|
# This tag requires that the tag SEARCHENGINE is set to YES. |
| 1713 |
|
|
| 1714 |
< |
EXTRA_SEARCH_MAPPINGS = |
| 1714 |
> |
EXTRA_SEARCH_MAPPINGS = |
| 1715 |
|
|
| 1716 |
|
#--------------------------------------------------------------------------- |
| 1717 |
|
# Configuration options related to the LaTeX output |
| 1733 |
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
| 1734 |
|
# invoked. |
| 1735 |
|
# |
| 1736 |
< |
# Note that when enabling USE_PDFLATEX this option is only used for generating |
| 1737 |
< |
# bitmaps for formulas in the HTML output, but not in the Makefile that is |
| 1738 |
< |
# written to the output directory. |
| 1739 |
< |
# The default file is: latex. |
| 1736 |
> |
# Note that when not enabling USE_PDFLATEX the default is latex when enabling |
| 1737 |
> |
# USE_PDFLATEX the default is pdflatex and when in the later case latex is |
| 1738 |
> |
# chosen this is overwritten by pdflatex. For specific output languages the |
| 1739 |
> |
# default can have been set differently, this depends on the implementation of |
| 1740 |
> |
# the output language. |
| 1741 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1742 |
|
|
| 1743 |
|
LATEX_CMD_NAME = latex |
| 1744 |
|
|
| 1745 |
|
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
| 1746 |
|
# index for LaTeX. |
| 1747 |
+ |
# Note: This tag is used in the Makefile / make.bat. |
| 1748 |
+ |
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file |
| 1749 |
+ |
# (.tex). |
| 1750 |
|
# The default file is: makeindex. |
| 1751 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1752 |
|
|
| 1753 |
|
MAKEINDEX_CMD_NAME = makeindex |
| 1754 |
|
|
| 1755 |
+ |
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to |
| 1756 |
+ |
# generate index for LaTeX. In case there is no backslash (\) as first character |
| 1757 |
+ |
# it will be automatically added in the LaTeX code. |
| 1758 |
+ |
# Note: This tag is used in the generated output file (.tex). |
| 1759 |
+ |
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. |
| 1760 |
+ |
# The default value is: makeindex. |
| 1761 |
+ |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1762 |
+ |
|
| 1763 |
+ |
LATEX_MAKEINDEX_CMD = makeindex |
| 1764 |
+ |
|
| 1765 |
|
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
| 1766 |
|
# documents. This may be useful for small projects and may help to save some |
| 1767 |
|
# trees in general. |
| 1789 |
|
# If left blank no extra packages will be included. |
| 1790 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1791 |
|
|
| 1792 |
< |
EXTRA_PACKAGES = |
| 1792 |
> |
EXTRA_PACKAGES = |
| 1793 |
|
|
| 1794 |
|
# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the |
| 1795 |
|
# generated LaTeX document. The header should contain everything until the first |
| 1805 |
|
# to HTML_HEADER. |
| 1806 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1807 |
|
|
| 1808 |
< |
LATEX_HEADER = |
| 1808 |
> |
LATEX_HEADER = |
| 1809 |
|
|
| 1810 |
|
# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the |
| 1811 |
|
# generated LaTeX document. The footer should contain everything after the last |
| 1816 |
|
# Note: Only use a user-defined footer if you know what you are doing! |
| 1817 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1818 |
|
|
| 1819 |
< |
LATEX_FOOTER = |
| 1819 |
> |
LATEX_FOOTER = |
| 1820 |
|
|
| 1821 |
|
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined |
| 1822 |
|
# LaTeX style sheets that are included after the standard style sheets created |
| 1827 |
|
# list). |
| 1828 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1829 |
|
|
| 1830 |
< |
LATEX_EXTRA_STYLESHEET = |
| 1830 |
> |
LATEX_EXTRA_STYLESHEET = |
| 1831 |
|
|
| 1832 |
|
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or |
| 1833 |
|
# other source files which should be copied to the LATEX_OUTPUT output |
| 1835 |
|
# markers available. |
| 1836 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1837 |
|
|
| 1838 |
< |
LATEX_EXTRA_FILES = |
| 1838 |
> |
LATEX_EXTRA_FILES = |
| 1839 |
|
|
| 1840 |
|
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is |
| 1841 |
|
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will |
| 1882 |
|
|
| 1883 |
|
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
| 1884 |
|
# bibliography, e.g. plainnat, or ieeetr. See |
| 1885 |
< |
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
| 1885 |
> |
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
| 1886 |
|
# The default value is: plain. |
| 1887 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1888 |
|
|
| 1896 |
|
|
| 1897 |
|
LATEX_TIMESTAMP = NO |
| 1898 |
|
|
| 1899 |
+ |
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) |
| 1900 |
+ |
# path from which the emoji images will be read. If a relative path is entered, |
| 1901 |
+ |
# it will be relative to the LATEX_OUTPUT directory. If left blank the |
| 1902 |
+ |
# LATEX_OUTPUT directory will be used. |
| 1903 |
+ |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
| 1904 |
+ |
|
| 1905 |
+ |
LATEX_EMOJI_DIRECTORY = |
| 1906 |
+ |
|
| 1907 |
|
#--------------------------------------------------------------------------- |
| 1908 |
|
# Configuration options related to the RTF output |
| 1909 |
|
#--------------------------------------------------------------------------- |
| 1943 |
|
|
| 1944 |
|
RTF_HYPERLINKS = NO |
| 1945 |
|
|
| 1946 |
< |
# Load stylesheet definitions from file. Syntax is similar to doxygen's config |
| 1947 |
< |
# file, i.e. a series of assignments. You only have to provide replacements, |
| 1948 |
< |
# missing definitions are set to their default value. |
| 1946 |
> |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
| 1947 |
> |
# configuration file, i.e. a series of assignments. You only have to provide |
| 1948 |
> |
# replacements, missing definitions are set to their default value. |
| 1949 |
|
# |
| 1950 |
|
# See also section "Doxygen usage" for information on how to generate the |
| 1951 |
|
# default style sheet that doxygen normally uses. |
| 1952 |
|
# This tag requires that the tag GENERATE_RTF is set to YES. |
| 1953 |
|
|
| 1954 |
< |
RTF_STYLESHEET_FILE = |
| 1954 |
> |
RTF_STYLESHEET_FILE = |
| 1955 |
|
|
| 1956 |
|
# Set optional variables used in the generation of an RTF document. Syntax is |
| 1957 |
< |
# similar to doxygen's config file. A template extensions file can be generated |
| 1958 |
< |
# using doxygen -e rtf extensionFile. |
| 1957 |
> |
# similar to doxygen's configuration file. A template extensions file can be |
| 1958 |
> |
# generated using doxygen -e rtf extensionFile. |
| 1959 |
|
# This tag requires that the tag GENERATE_RTF is set to YES. |
| 1960 |
|
|
| 1961 |
< |
RTF_EXTENSIONS_FILE = |
| 1961 |
> |
RTF_EXTENSIONS_FILE = |
| 1962 |
|
|
| 1963 |
|
# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code |
| 1964 |
|
# with syntax highlighting in the RTF output. |
| 2003 |
|
# MAN_EXTENSION with the initial . removed. |
| 2004 |
|
# This tag requires that the tag GENERATE_MAN is set to YES. |
| 2005 |
|
|
| 2006 |
< |
MAN_SUBDIR = |
| 2006 |
> |
MAN_SUBDIR = |
| 2007 |
|
|
| 2008 |
|
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it |
| 2009 |
|
# will generate one additional man file for each entity documented in the real |
| 2041 |
|
|
| 2042 |
|
XML_PROGRAMLISTING = YES |
| 2043 |
|
|
| 2044 |
+ |
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include |
| 2045 |
+ |
# namespace members in file scope as well, matching the HTML output. |
| 2046 |
+ |
# The default value is: NO. |
| 2047 |
+ |
# This tag requires that the tag GENERATE_XML is set to YES. |
| 2048 |
+ |
|
| 2049 |
+ |
XML_NS_MEMB_FILE_SCOPE = NO |
| 2050 |
+ |
|
| 2051 |
|
#--------------------------------------------------------------------------- |
| 2052 |
|
# Configuration options related to the DOCBOOK output |
| 2053 |
|
#--------------------------------------------------------------------------- |
| 2080 |
|
#--------------------------------------------------------------------------- |
| 2081 |
|
|
| 2082 |
|
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
| 2083 |
< |
# AutoGen Definitions (see http://autogen.sf.net) file that captures the |
| 2084 |
< |
# structure of the code including all documentation. Note that this feature is |
| 2085 |
< |
# still experimental and incomplete at the moment. |
| 2083 |
> |
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures |
| 2084 |
> |
# the structure of the code including all documentation. Note that this feature |
| 2085 |
> |
# is still experimental and incomplete at the moment. |
| 2086 |
|
# The default value is: NO. |
| 2087 |
|
|
| 2088 |
|
GENERATE_AUTOGEN_DEF = NO |
| 2123 |
|
# overwrite each other's variables. |
| 2124 |
|
# This tag requires that the tag GENERATE_PERLMOD is set to YES. |
| 2125 |
|
|
| 2126 |
< |
PERLMOD_MAKEVAR_PREFIX = |
| 2126 |
> |
PERLMOD_MAKEVAR_PREFIX = |
| 2127 |
|
|
| 2128 |
|
#--------------------------------------------------------------------------- |
| 2129 |
|
# Configuration options related to the preprocessor |
| 2164 |
|
# preprocessor. |
| 2165 |
|
# This tag requires that the tag SEARCH_INCLUDES is set to YES. |
| 2166 |
|
|
| 2167 |
< |
INCLUDE_PATH = |
| 2167 |
> |
INCLUDE_PATH = |
| 2168 |
|
|
| 2169 |
|
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard |
| 2170 |
|
# patterns (like *.h and *.hpp) to filter out the header-files in the |
| 2172 |
|
# used. |
| 2173 |
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 2174 |
|
|
| 2175 |
< |
INCLUDE_FILE_PATTERNS = |
| 2175 |
> |
INCLUDE_FILE_PATTERNS = |
| 2176 |
|
|
| 2177 |
|
# The PREDEFINED tag can be used to specify one or more macro names that are |
| 2178 |
|
# defined before the preprocessor is started (similar to the -D option of e.g. |
| 2185 |
|
PREDEFINED = BREP_SAT \ |
| 2186 |
|
BREP_STEP \ |
| 2187 |
|
BREP_SLD \ |
| 2188 |
< |
BREP_OCC |
| 2188 |
> |
BREP_OCC \ |
| 2189 |
> |
ALL_OCC |
| 2190 |
|
|
| 2191 |
|
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this |
| 2192 |
|
# tag can be used to specify a list of macro names that should be expanded. The |
| 2195 |
|
# definition found in the source code. |
| 2196 |
|
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. |
| 2197 |
|
|
| 2198 |
< |
EXPAND_AS_DEFINED = |
| 2198 |
> |
EXPAND_AS_DEFINED = |
| 2199 |
|
|
| 2200 |
|
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will |
| 2201 |
|
# remove all references to function-like macros that are alone on a line, have |
| 2224 |
|
# the path). If a tag file is not located in the directory in which doxygen is |
| 2225 |
|
# run, you must also specify the path to the tagfile here. |
| 2226 |
|
|
| 2227 |
< |
TAGFILES = |
| 2227 |
> |
TAGFILES = |
| 2228 |
|
|
| 2229 |
|
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a |
| 2230 |
|
# tag file that is based on the input files it reads. See section "Linking to |
| 2231 |
|
# external documentation" for more information about the usage of tag files. |
| 2232 |
|
|
| 2233 |
< |
GENERATE_TAGFILE = |
| 2233 |
> |
GENERATE_TAGFILE = |
| 2234 |
|
|
| 2235 |
|
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in |
| 2236 |
|
# the class index. If set to NO, only the inherited external classes will be |
| 2253 |
|
|
| 2254 |
|
EXTERNAL_PAGES = YES |
| 2255 |
|
|
| 2158 |
– |
# The PERL_PATH should be the absolute path and name of the perl script |
| 2159 |
– |
# interpreter (i.e. the result of 'which perl'). |
| 2160 |
– |
# The default file (with absolute path) is: /usr/bin/perl. |
| 2161 |
– |
|
| 2162 |
– |
PERL_PATH = /usr/bin/perl |
| 2163 |
– |
|
| 2256 |
|
#--------------------------------------------------------------------------- |
| 2257 |
|
# Configuration options related to the dot tool |
| 2258 |
|
#--------------------------------------------------------------------------- |
| 2266 |
|
|
| 2267 |
|
CLASS_DIAGRAMS = YES |
| 2268 |
|
|
| 2177 |
– |
# You can define message sequence charts within doxygen comments using the \msc |
| 2178 |
– |
# command. Doxygen will then run the mscgen tool (see: |
| 2179 |
– |
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
| 2180 |
– |
# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
| 2181 |
– |
# the mscgen tool resides. If left empty the tool is assumed to be found in the |
| 2182 |
– |
# default search path. |
| 2183 |
– |
|
| 2184 |
– |
MSCGEN_PATH = |
| 2185 |
– |
|
| 2269 |
|
# You can include diagrams made with dia in doxygen documentation. Doxygen will |
| 2270 |
|
# then run dia to produce the diagram and insert it in the documentation. The |
| 2271 |
|
# DIA_PATH tag allows you to specify the directory where the dia binary resides. |
| 2272 |
|
# If left empty dia is assumed to be found in the default search path. |
| 2273 |
|
|
| 2274 |
< |
DIA_PATH = |
| 2274 |
> |
DIA_PATH = |
| 2275 |
|
|
| 2276 |
|
# If set to YES the inheritance and collaboration graphs will hide inheritance |
| 2277 |
|
# and usage relations if the target is undocumented or is not a class. |
| 2320 |
|
# the path where dot can find it using this tag. |
| 2321 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
| 2322 |
|
|
| 2323 |
< |
DOT_FONTPATH = |
| 2323 |
> |
DOT_FONTPATH = |
| 2324 |
|
|
| 2325 |
|
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for |
| 2326 |
|
# each documented class showing the direct and indirect inheritance relations. |
| 2466 |
|
# found. If left blank, it is assumed the dot tool can be found in the path. |
| 2467 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
| 2468 |
|
|
| 2469 |
< |
DOT_PATH = |
| 2469 |
> |
DOT_PATH = |
| 2470 |
|
|
| 2471 |
|
# The DOTFILE_DIRS tag can be used to specify one or more directories that |
| 2472 |
|
# contain dot files that are included in the documentation (see the \dotfile |
| 2473 |
|
# command). |
| 2474 |
|
# This tag requires that the tag HAVE_DOT is set to YES. |
| 2475 |
|
|
| 2476 |
< |
DOTFILE_DIRS = |
| 2476 |
> |
DOTFILE_DIRS = |
| 2477 |
|
|
| 2478 |
|
# The MSCFILE_DIRS tag can be used to specify one or more directories that |
| 2479 |
|
# contain msc files that are included in the documentation (see the \mscfile |
| 2480 |
|
# command). |
| 2481 |
|
|
| 2482 |
< |
MSCFILE_DIRS = |
| 2482 |
> |
MSCFILE_DIRS = |
| 2483 |
|
|
| 2484 |
|
# The DIAFILE_DIRS tag can be used to specify one or more directories that |
| 2485 |
|
# contain dia files that are included in the documentation (see the \diafile |
| 2486 |
|
# command). |
| 2487 |
|
|
| 2488 |
< |
DIAFILE_DIRS = |
| 2488 |
> |
DIAFILE_DIRS = |
| 2489 |
|
|
| 2490 |
|
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the |
| 2491 |
|
# path where java can find the plantuml.jar file. If left blank, it is assumed |
| 2493 |
|
# generate a warning when it encounters a \startuml command in this case and |
| 2494 |
|
# will not generate output for the diagram. |
| 2495 |
|
|
| 2496 |
< |
PLANTUML_JAR_PATH = |
| 2496 |
> |
PLANTUML_JAR_PATH = |
| 2497 |
|
|
| 2498 |
|
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a |
| 2499 |
|
# configuration file for plantuml. |
| 2500 |
|
|
| 2501 |
< |
PLANTUML_CFG_FILE = |
| 2501 |
> |
PLANTUML_CFG_FILE = |
| 2502 |
|
|
| 2503 |
|
# When using plantuml, the specified paths are searched for files specified by |
| 2504 |
|
# the !include statement in a plantuml block. |
| 2505 |
|
|
| 2506 |
< |
PLANTUML_INCLUDE_PATH = |
| 2506 |
> |
PLANTUML_INCLUDE_PATH = |
| 2507 |
|
|
| 2508 |
|
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes |
| 2509 |
|
# that will be shown in the graph. If the number of nodes in a graph becomes |
