1 |
# Doxyfile 1.8.11 |
# Doxyfile 1.8.16 |
2 |
|
|
3 |
# This file describes the settings to be used by the documentation system |
# This file describes the settings to be used by the documentation system |
4 |
# doxygen (www.doxygen.org) for a project. |
# doxygen (www.doxygen.org) for a project. |
17 |
# Project related configuration options |
# Project related configuration options |
18 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
19 |
|
|
20 |
# This tag specifies the encoding used for all characters in the config file |
# This tag specifies the encoding used for all characters in the configuration |
21 |
# that follow. The default is UTF-8 which is also the encoding used for all text |
# file that follow. The default is UTF-8 which is also the encoding used for all |
22 |
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv |
# text before the first occurrence of this tag. Doxygen uses libiconv (or the |
23 |
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv |
# iconv built into libc) for the transcoding. See |
24 |
# for the list of possible encodings. |
# https://www.gnu.org/software/libiconv/ for the list of possible encodings. |
25 |
# The default value is: UTF-8. |
# The default value is: UTF-8. |
26 |
|
|
27 |
DOXYFILE_ENCODING = UTF-8 |
DOXYFILE_ENCODING = UTF-8 |
93 |
|
|
94 |
OUTPUT_LANGUAGE = English |
OUTPUT_LANGUAGE = English |
95 |
|
|
96 |
|
# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all |
97 |
|
# documentation generated by doxygen is written. Doxygen will use this |
98 |
|
# information to generate all generated output in the proper direction. |
99 |
|
# Possible values are: None, LTR, RTL and Context. |
100 |
|
# The default value is: None. |
101 |
|
|
102 |
|
OUTPUT_TEXT_DIRECTION = None |
103 |
|
|
104 |
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member |
# 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 |
# descriptions after the members that are listed in the file and class |
106 |
# documentation (similar to Javadoc). Set to NO to disable this. |
# documentation (similar to Javadoc). Set to NO to disable this. |
187 |
|
|
188 |
JAVADOC_AUTOBRIEF = NO |
JAVADOC_AUTOBRIEF = NO |
189 |
|
|
190 |
|
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line |
191 |
|
# such as |
192 |
|
# /*************** |
193 |
|
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the |
194 |
|
# Javadoc-style will behave just like regular comments and it will not be |
195 |
|
# interpreted by doxygen. |
196 |
|
# The default value is: NO. |
197 |
|
|
198 |
|
JAVADOC_BANNER = NO |
199 |
|
|
200 |
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first |
201 |
# line (until the first dot) of a Qt-style comment as the brief description. If |
# line (until the first dot) of a Qt-style comment as the brief description. If |
202 |
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus |
244 |
# will allow you to put the command \sideeffect (or @sideeffect) in the |
# will allow you to put the command \sideeffect (or @sideeffect) in the |
245 |
# documentation, which will result in a user-defined paragraph with heading |
# documentation, which will result in a user-defined paragraph with heading |
246 |
# "Side Effects:". You can put \n's in the value part of an alias to insert |
# "Side Effects:". You can put \n's in the value part of an alias to insert |
247 |
# newlines. |
# newlines (in the resulting output). You can put ^^ in the value part of an |
248 |
|
# alias to insert a newline as if a physical newline was in the original file. |
249 |
|
# When you need a literal { or } or , in the value part of an alias you have to |
250 |
|
# escape them by means of a backslash (\), this can lead to conflicts with the |
251 |
|
# commands \{ and \} for these it is advised to use the version @{ and @} or use |
252 |
|
# a double escape (\\{ and \\}) |
253 |
|
|
254 |
ALIASES = |
ALIASES = |
255 |
|
|
287 |
|
|
288 |
OPTIMIZE_OUTPUT_VHDL = NO |
OPTIMIZE_OUTPUT_VHDL = NO |
289 |
|
|
290 |
|
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice |
291 |
|
# sources only. Doxygen will then generate output that is more tailored for that |
292 |
|
# language. For instance, namespaces will be presented as modules, types will be |
293 |
|
# separated into more groups, etc. |
294 |
|
# The default value is: NO. |
295 |
|
|
296 |
|
OPTIMIZE_OUTPUT_SLICE = NO |
297 |
|
|
298 |
# Doxygen selects the parser to use depending on the extension of the files it |
# Doxygen selects the parser to use depending on the extension of the files it |
299 |
# parses. With this tag you can assign which parser to use for a given |
# parses. With this tag you can assign which parser to use for a given |
300 |
# extension. Doxygen has a built-in mapping, but you can override or extend it |
# extension. Doxygen has a built-in mapping, but you can override or extend it |
301 |
# using this tag. The format is ext=language, where ext is a file extension, and |
# using this tag. The format is ext=language, where ext is a file extension, and |
302 |
# language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
# language is one of the parsers supported by doxygen: IDL, Java, Javascript, |
303 |
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: |
# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, |
304 |
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: |
# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
305 |
# Fortran. In the later case the parser tries to guess whether the code is fixed |
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
306 |
# or free formatted code, this is the default for Fortran type files), VHDL. For |
# tries to guess whether the code is fixed or free formatted code, this is the |
307 |
# instance to make doxygen treat .inc files as Fortran files (default is PHP), |
# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat |
308 |
# and .f files as C (default is Fortran), use: inc=Fortran f=C. |
# .inc files as Fortran files (default is PHP), and .f files as C (default is |
309 |
|
# Fortran), use: inc=Fortran f=C. |
310 |
# |
# |
311 |
# Note: For files without extension you can use no_extension as a placeholder. |
# Note: For files without extension you can use no_extension as a placeholder. |
312 |
# |
# |
317 |
|
|
318 |
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments |
319 |
# according to the Markdown format, which allows for more readable |
# according to the Markdown format, which allows for more readable |
320 |
# documentation. See http://daringfireball.net/projects/markdown/ for details. |
# documentation. See https://daringfireball.net/projects/markdown/ for details. |
321 |
# The output of markdown processing is further processed by doxygen, so you can |
# The output of markdown processing is further processed by doxygen, so you can |
322 |
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in |
323 |
# case of backward compatibilities issues. |
# case of backward compatibilities issues. |
325 |
|
|
326 |
MARKDOWN_SUPPORT = YES |
MARKDOWN_SUPPORT = YES |
327 |
|
|
328 |
|
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up |
329 |
|
# to that level are automatically included in the table of contents, even if |
330 |
|
# they do not have an id attribute. |
331 |
|
# Note: This feature currently applies only to Markdown headings. |
332 |
|
# Minimum value: 0, maximum value: 99, default value: 5. |
333 |
|
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. |
334 |
|
|
335 |
|
TOC_INCLUDE_HEADINGS = 5 |
336 |
|
|
337 |
# When enabled doxygen tries to link words that correspond to documented |
# When enabled doxygen tries to link words that correspond to documented |
338 |
# classes, or namespaces to their corresponding documentation. Such a link can |
# classes, or namespaces to their corresponding documentation. Such a link can |
339 |
# be prevented in individual cases by putting a % sign in front of the word or |
# be prevented in individual cases by putting a % sign in front of the word or |
359 |
CPP_CLI_SUPPORT = NO |
CPP_CLI_SUPPORT = NO |
360 |
|
|
361 |
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: |
362 |
# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen |
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen |
363 |
# will parse them like normal C++ but will assume all classes use public instead |
# will parse them like normal C++ but will assume all classes use public instead |
364 |
# of private inheritance when no explicit protection keyword is present. |
# of private inheritance when no explicit protection keyword is present. |
365 |
# The default value is: NO. |
# The default value is: NO. |
465 |
|
|
466 |
EXTRACT_PRIVATE = NO |
EXTRACT_PRIVATE = NO |
467 |
|
|
468 |
|
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual |
469 |
|
# methods of a class will be included in the documentation. |
470 |
|
# The default value is: NO. |
471 |
|
|
472 |
|
EXTRACT_PRIV_VIRTUAL = NO |
473 |
|
|
474 |
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal |
475 |
# scope will be included in the documentation. |
# scope will be included in the documentation. |
476 |
# The default value is: NO. |
# The default value is: NO. |
549 |
# names in lower-case letters. If set to YES, upper-case letters are also |
# names in lower-case letters. If set to YES, upper-case letters are also |
550 |
# allowed. This is useful if you have classes or files whose names only differ |
# allowed. This is useful if you have classes or files whose names only differ |
551 |
# in case and if your file system supports case sensitive file names. Windows |
# in case and if your file system supports case sensitive file names. Windows |
552 |
# and Mac users are advised to set this option to NO. |
# (including Cygwin) ands Mac users are advised to set this option to NO. |
553 |
# The default value is: system dependent. |
# The default value is: system dependent. |
554 |
|
|
555 |
CASE_SENSE_NAMES = YES |
CASE_SENSE_NAMES = YES |
736 |
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing |
737 |
# the reference definitions. This must be a list of .bib files. The .bib |
# the reference definitions. This must be a list of .bib files. The .bib |
738 |
# extension is automatically appended if omitted. This requires the bibtex tool |
# extension is automatically appended if omitted. This requires the bibtex tool |
739 |
# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. |
# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. |
740 |
# For LaTeX the style of the bibliography can be controlled using |
# For LaTeX the style of the bibliography can be controlled using |
741 |
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the |
742 |
# search path. See also \cite for info how to create references. |
# search path. See also \cite for info how to create references. |
781 |
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that |
782 |
# are documented, but have no documentation for their parameters or return |
# are documented, but have no documentation for their parameters or return |
783 |
# value. If set to NO, doxygen will only warn about wrong or incomplete |
# value. If set to NO, doxygen will only warn about wrong or incomplete |
784 |
# parameter documentation, but not about the absence of documentation. |
# parameter documentation, but not about the absence of documentation. If |
785 |
|
# EXTRACT_ALL is set to YES then this flag will automatically be disabled. |
786 |
# The default value is: NO. |
# The default value is: NO. |
787 |
|
|
788 |
WARN_NO_PARAMDOC = NO |
WARN_NO_PARAMDOC = NO |
824 |
# This tag can be used to specify the character encoding of the source files |
# This tag can be used to specify the character encoding of the source files |
825 |
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses |
826 |
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv |
827 |
# documentation (see: http://www.gnu.org/software/libiconv) for the list of |
# documentation (see: https://www.gnu.org/software/libiconv/) for the list of |
828 |
# possible encodings. |
# possible encodings. |
829 |
# The default value is: UTF-8. |
# The default value is: UTF-8. |
830 |
|
|
841 |
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, |
842 |
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, |
843 |
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, |
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, |
844 |
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, |
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, |
845 |
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. |
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. |
846 |
|
|
847 |
FILE_PATTERNS = *.dox \ |
FILE_PATTERNS = *.dox \ |
848 |
*.h \ |
*.h \ |
1001 |
STRIP_CODE_COMMENTS = YES |
STRIP_CODE_COMMENTS = YES |
1002 |
|
|
1003 |
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
# If the REFERENCED_BY_RELATION tag is set to YES then for each documented |
1004 |
# function all documented functions referencing it will be listed. |
# entity all documented functions referencing it will be listed. |
1005 |
# The default value is: NO. |
# The default value is: NO. |
1006 |
|
|
1007 |
REFERENCED_BY_RELATION = YES |
REFERENCED_BY_RELATION = YES |
1033 |
# If the USE_HTAGS tag is set to YES then the references to source code will |
# If the USE_HTAGS tag is set to YES then the references to source code will |
1034 |
# point to the HTML generated by the htags(1) tool instead of doxygen built-in |
# point to the HTML generated by the htags(1) tool instead of doxygen built-in |
1035 |
# source browser. The htags tool is part of GNU's global source tagging system |
# source browser. The htags tool is part of GNU's global source tagging system |
1036 |
# (see http://www.gnu.org/software/global/global.html). You will need version |
# (see https://www.gnu.org/software/global/global.html). You will need version |
1037 |
# 4.8.6 or higher. |
# 4.8.6 or higher. |
1038 |
# |
# |
1039 |
# To use it do the following: |
# To use it do the following: |
1040 |
# - Install the latest version of global |
# - Install the latest version of global |
1041 |
# - Enable SOURCE_BROWSER and USE_HTAGS in the config file |
# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file |
1042 |
# - Make sure the INPUT points to the root of the source tree |
# - Make sure the INPUT points to the root of the source tree |
1043 |
# - Run doxygen as normal |
# - Run doxygen as normal |
1044 |
# |
# |
1060 |
|
|
1061 |
VERBATIM_HEADERS = YES |
VERBATIM_HEADERS = YES |
1062 |
|
|
|
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the |
|
|
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the |
|
|
# cost of reduced performance. This can be particularly helpful with template |
|
|
# rich C++ code for which doxygen's built-in parser lacks the necessary type |
|
|
# information. |
|
|
# Note: The availability of this option depends on whether or not doxygen was |
|
|
# generated with the -Duse-libclang=ON option for CMake. |
|
|
# The default value is: NO. |
|
|
|
|
|
CLANG_ASSISTED_PARSING = NO |
|
|
|
|
|
# If clang assisted parsing is enabled you can provide the compiler with command |
|
|
# line options that you would normally use when invoking the compiler. Note that |
|
|
# the include paths will already be set by doxygen for the files and directories |
|
|
# specified with INPUT and INCLUDE_PATH. |
|
|
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. |
|
|
|
|
|
CLANG_OPTIONS = |
|
|
|
|
1063 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
1064 |
# Configuration options related to the alphabetical class index |
# Configuration options related to the alphabetical class index |
1065 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
1178 |
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen |
1179 |
# will adjust the colors in the style sheet and background images according to |
# will adjust the colors in the style sheet and background images according to |
1180 |
# this color. Hue is specified as an angle on a colorwheel, see |
# this color. Hue is specified as an angle on a colorwheel, see |
1181 |
# http://en.wikipedia.org/wiki/Hue for more information. For instance the value |
# https://en.wikipedia.org/wiki/Hue for more information. For instance the value |
1182 |
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 |
1183 |
# purple, and 360 is red again. |
# purple, and 360 is red again. |
1184 |
# Minimum value: 0, maximum value: 359, default value: 220. |
# Minimum value: 0, maximum value: 359, default value: 220. |
1214 |
|
|
1215 |
HTML_TIMESTAMP = NO |
HTML_TIMESTAMP = NO |
1216 |
|
|
1217 |
|
# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML |
1218 |
|
# documentation will contain a main index with vertical navigation menus that |
1219 |
|
# are dynamically created via Javascript. If disabled, the navigation index will |
1220 |
|
# consists of multiple levels of tabs that are statically embedded in every HTML |
1221 |
|
# page. Disable this option to support browsers that do not have Javascript, |
1222 |
|
# like the Qt help browser. |
1223 |
|
# The default value is: YES. |
1224 |
|
# This tag requires that the tag GENERATE_HTML is set to YES. |
1225 |
|
|
1226 |
|
HTML_DYNAMIC_MENUS = YES |
1227 |
|
|
1228 |
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML |
1229 |
# documentation will contain sections that can be hidden and shown after the |
# documentation will contain sections that can be hidden and shown after the |
1230 |
# page has loaded. |
# page has loaded. |
1248 |
|
|
1249 |
# If the GENERATE_DOCSET tag is set to YES, additional index files will be |
# If the GENERATE_DOCSET tag is set to YES, additional index files will be |
1250 |
# generated that can be used as input for Apple's Xcode 3 integrated development |
# generated that can be used as input for Apple's Xcode 3 integrated development |
1251 |
# environment (see: http://developer.apple.com/tools/xcode/), introduced with |
# environment (see: https://developer.apple.com/xcode/), introduced with OSX |
1252 |
# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a |
# 10.5 (Leopard). To create a documentation set, doxygen will generate a |
1253 |
# Makefile in the HTML output directory. Running make will produce the docset in |
# Makefile in the HTML output directory. Running make will produce the docset in |
1254 |
# that directory and running make install will install the docset in |
# that directory and running make install will install the docset in |
1255 |
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at |
1256 |
# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html |
# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy |
1257 |
# for more information. |
# genXcode/_index.html for more information. |
1258 |
# The default value is: NO. |
# The default value is: NO. |
1259 |
# This tag requires that the tag GENERATE_HTML is set to YES. |
# This tag requires that the tag GENERATE_HTML is set to YES. |
1260 |
|
|
1293 |
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three |
1294 |
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
# additional HTML index files: index.hhp, index.hhc, and index.hhk. The |
1295 |
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop |
1296 |
# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on |
1297 |
# Windows. |
# Windows. |
1298 |
# |
# |
1299 |
# The HTML Help Workshop contains a compiler that can convert all HTML output |
# The HTML Help Workshop contains a compiler that can convert all HTML output |
1369 |
|
|
1370 |
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help |
1371 |
# Project output. For more information please see Qt Help Project / Namespace |
# Project output. For more information please see Qt Help Project / Namespace |
1372 |
# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). |
# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). |
1373 |
# The default value is: org.doxygen.Project. |
# The default value is: org.doxygen.Project. |
1374 |
# This tag requires that the tag GENERATE_QHP is set to YES. |
# This tag requires that the tag GENERATE_QHP is set to YES. |
1375 |
|
|
1377 |
|
|
1378 |
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt |
1379 |
# Help Project output. For more information please see Qt Help Project / Virtual |
# Help Project output. For more information please see Qt Help Project / Virtual |
1380 |
# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- |
# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- |
1381 |
# folders). |
# folders). |
1382 |
# The default value is: doc. |
# The default value is: doc. |
1383 |
# This tag requires that the tag GENERATE_QHP is set to YES. |
# This tag requires that the tag GENERATE_QHP is set to YES. |
1386 |
|
|
1387 |
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom |
1388 |
# filter to add. For more information please see Qt Help Project / Custom |
# filter to add. For more information please see Qt Help Project / Custom |
1389 |
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
1390 |
# filters). |
# filters). |
1391 |
# This tag requires that the tag GENERATE_QHP is set to YES. |
# This tag requires that the tag GENERATE_QHP is set to YES. |
1392 |
|
|
1394 |
|
|
1395 |
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the |
1396 |
# custom filter to add. For more information please see Qt Help Project / Custom |
# custom filter to add. For more information please see Qt Help Project / Custom |
1397 |
# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- |
# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- |
1398 |
# filters). |
# filters). |
1399 |
# This tag requires that the tag GENERATE_QHP is set to YES. |
# This tag requires that the tag GENERATE_QHP is set to YES. |
1400 |
|
|
1402 |
|
|
1403 |
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this |
1404 |
# project's filter section matches. Qt Help Project / Filter Attributes (see: |
# project's filter section matches. Qt Help Project / Filter Attributes (see: |
1405 |
# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). |
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). |
1406 |
# This tag requires that the tag GENERATE_QHP is set to YES. |
# This tag requires that the tag GENERATE_QHP is set to YES. |
1407 |
|
|
1408 |
QHP_SECT_FILTER_ATTRS = |
QHP_SECT_FILTER_ATTRS = |
1495 |
|
|
1496 |
FORMULA_FONTSIZE = 10 |
FORMULA_FONTSIZE = 10 |
1497 |
|
|
1498 |
# Use the FORMULA_TRANPARENT tag to determine whether or not the images |
# Use the FORMULA_TRANSPARENT tag to determine whether or not the images |
1499 |
# generated for formulas are transparent PNGs. Transparent PNGs are not |
# generated for formulas are transparent PNGs. Transparent PNGs are not |
1500 |
# supported properly for IE 6.0, but are supported on all modern browsers. |
# supported properly for IE 6.0, but are supported on all modern browsers. |
1501 |
# |
# |
1507 |
FORMULA_TRANSPARENT = YES |
FORMULA_TRANSPARENT = YES |
1508 |
|
|
1509 |
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see |
1510 |
# http://www.mathjax.org) which uses client side Javascript for the rendering |
# https://www.mathjax.org) which uses client side Javascript for the rendering |
1511 |
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX |
1512 |
# installed or if you want to formulas look prettier in the HTML output. When |
# installed or if you want to formulas look prettier in the HTML output. When |
1513 |
# enabled you may also need to install MathJax separately and configure the path |
# enabled you may also need to install MathJax separately and configure the path |
1534 |
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax |
1535 |
# Content Delivery Network so you can quickly see the result without installing |
# Content Delivery Network so you can quickly see the result without installing |
1536 |
# MathJax. However, it is strongly recommended to install a local copy of |
# MathJax. However, it is strongly recommended to install a local copy of |
1537 |
# MathJax from http://www.mathjax.org before deployment. |
# MathJax from https://www.mathjax.org before deployment. |
1538 |
# The default value is: http://cdn.mathjax.org/mathjax/latest. |
# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. |
1539 |
# This tag requires that the tag USE_MATHJAX is set to YES. |
# This tag requires that the tag USE_MATHJAX is set to YES. |
1540 |
|
|
1541 |
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
1596 |
# |
# |
1597 |
# Doxygen ships with an example indexer (doxyindexer) and search engine |
# Doxygen ships with an example indexer (doxyindexer) and search engine |
1598 |
# (doxysearch.cgi) which are based on the open source search engine library |
# (doxysearch.cgi) which are based on the open source search engine library |
1599 |
# Xapian (see: http://xapian.org/). |
# Xapian (see: https://xapian.org/). |
1600 |
# |
# |
1601 |
# See the section "External Indexing and Searching" for details. |
# See the section "External Indexing and Searching" for details. |
1602 |
# The default value is: NO. |
# The default value is: NO. |
1609 |
# |
# |
1610 |
# Doxygen ships with an example indexer (doxyindexer) and search engine |
# Doxygen ships with an example indexer (doxyindexer) and search engine |
1611 |
# (doxysearch.cgi) which are based on the open source search engine library |
# (doxysearch.cgi) which are based on the open source search engine library |
1612 |
# Xapian (see: http://xapian.org/). See the section "External Indexing and |
# Xapian (see: https://xapian.org/). See the section "External Indexing and |
1613 |
# Searching" for details. |
# Searching" for details. |
1614 |
# This tag requires that the tag SEARCHENGINE is set to YES. |
# This tag requires that the tag SEARCHENGINE is set to YES. |
1615 |
|
|
1661 |
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be |
1662 |
# invoked. |
# invoked. |
1663 |
# |
# |
1664 |
# Note that when enabling USE_PDFLATEX this option is only used for generating |
# Note that when not enabling USE_PDFLATEX the default is latex when enabling |
1665 |
# bitmaps for formulas in the HTML output, but not in the Makefile that is |
# USE_PDFLATEX the default is pdflatex and when in the later case latex is |
1666 |
# written to the output directory. |
# chosen this is overwritten by pdflatex. For specific output languages the |
1667 |
# The default file is: latex. |
# default can have been set differently, this depends on the implementation of |
1668 |
|
# the output language. |
1669 |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1670 |
|
|
1671 |
LATEX_CMD_NAME = latex |
LATEX_CMD_NAME = latex |
1672 |
|
|
1673 |
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate |
1674 |
# index for LaTeX. |
# index for LaTeX. |
1675 |
|
# Note: This tag is used in the Makefile / make.bat. |
1676 |
|
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file |
1677 |
|
# (.tex). |
1678 |
# The default file is: makeindex. |
# The default file is: makeindex. |
1679 |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1680 |
|
|
1681 |
MAKEINDEX_CMD_NAME = makeindex |
MAKEINDEX_CMD_NAME = makeindex |
1682 |
|
|
1683 |
|
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to |
1684 |
|
# generate index for LaTeX. In case there is no backslash (\) as first character |
1685 |
|
# it will be automatically added in the LaTeX code. |
1686 |
|
# Note: This tag is used in the generated output file (.tex). |
1687 |
|
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. |
1688 |
|
# The default value is: makeindex. |
1689 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1690 |
|
|
1691 |
|
LATEX_MAKEINDEX_CMD = makeindex |
1692 |
|
|
1693 |
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX |
1694 |
# documents. This may be useful for small projects and may help to save some |
# documents. This may be useful for small projects and may help to save some |
1695 |
# trees in general. |
# trees in general. |
1810 |
|
|
1811 |
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the |
1812 |
# bibliography, e.g. plainnat, or ieeetr. See |
# bibliography, e.g. plainnat, or ieeetr. See |
1813 |
# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. |
1814 |
# The default value is: plain. |
# The default value is: plain. |
1815 |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1816 |
|
|
1824 |
|
|
1825 |
LATEX_TIMESTAMP = NO |
LATEX_TIMESTAMP = NO |
1826 |
|
|
1827 |
|
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) |
1828 |
|
# path from which the emoji images will be read. If a relative path is entered, |
1829 |
|
# it will be relative to the LATEX_OUTPUT directory. If left blank the |
1830 |
|
# LATEX_OUTPUT directory will be used. |
1831 |
|
# This tag requires that the tag GENERATE_LATEX is set to YES. |
1832 |
|
|
1833 |
|
LATEX_EMOJI_DIRECTORY = |
1834 |
|
|
1835 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
1836 |
# Configuration options related to the RTF output |
# Configuration options related to the RTF output |
1837 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
1871 |
|
|
1872 |
RTF_HYPERLINKS = NO |
RTF_HYPERLINKS = NO |
1873 |
|
|
1874 |
# Load stylesheet definitions from file. Syntax is similar to doxygen's config |
# Load stylesheet definitions from file. Syntax is similar to doxygen's |
1875 |
# file, i.e. a series of assignments. You only have to provide replacements, |
# configuration file, i.e. a series of assignments. You only have to provide |
1876 |
# missing definitions are set to their default value. |
# replacements, missing definitions are set to their default value. |
1877 |
# |
# |
1878 |
# See also section "Doxygen usage" for information on how to generate the |
# See also section "Doxygen usage" for information on how to generate the |
1879 |
# default style sheet that doxygen normally uses. |
# default style sheet that doxygen normally uses. |
1882 |
RTF_STYLESHEET_FILE = |
RTF_STYLESHEET_FILE = |
1883 |
|
|
1884 |
# Set optional variables used in the generation of an RTF document. Syntax is |
# Set optional variables used in the generation of an RTF document. Syntax is |
1885 |
# similar to doxygen's config file. A template extensions file can be generated |
# similar to doxygen's configuration file. A template extensions file can be |
1886 |
# using doxygen -e rtf extensionFile. |
# generated using doxygen -e rtf extensionFile. |
1887 |
# This tag requires that the tag GENERATE_RTF is set to YES. |
# This tag requires that the tag GENERATE_RTF is set to YES. |
1888 |
|
|
1889 |
RTF_EXTENSIONS_FILE = |
RTF_EXTENSIONS_FILE = |
1969 |
|
|
1970 |
XML_PROGRAMLISTING = YES |
XML_PROGRAMLISTING = YES |
1971 |
|
|
1972 |
|
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include |
1973 |
|
# namespace members in file scope as well, matching the HTML output. |
1974 |
|
# The default value is: NO. |
1975 |
|
# This tag requires that the tag GENERATE_XML is set to YES. |
1976 |
|
|
1977 |
|
XML_NS_MEMB_FILE_SCOPE = NO |
1978 |
|
|
1979 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
1980 |
# Configuration options related to the DOCBOOK output |
# Configuration options related to the DOCBOOK output |
1981 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
2008 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
2009 |
|
|
2010 |
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an |
2011 |
# AutoGen Definitions (see http://autogen.sf.net) file that captures the |
# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures |
2012 |
# structure of the code including all documentation. Note that this feature is |
# the structure of the code including all documentation. Note that this feature |
2013 |
# still experimental and incomplete at the moment. |
# is still experimental and incomplete at the moment. |
2014 |
# The default value is: NO. |
# The default value is: NO. |
2015 |
|
|
2016 |
GENERATE_AUTOGEN_DEF = NO |
GENERATE_AUTOGEN_DEF = NO |
2177 |
|
|
2178 |
EXTERNAL_PAGES = YES |
EXTERNAL_PAGES = YES |
2179 |
|
|
|
# The PERL_PATH should be the absolute path and name of the perl script |
|
|
# interpreter (i.e. the result of 'which perl'). |
|
|
# The default file (with absolute path) is: /usr/bin/perl. |
|
|
|
|
|
PERL_PATH = /usr/bin/perl |
|
|
|
|
2180 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
2181 |
# Configuration options related to the dot tool |
# Configuration options related to the dot tool |
2182 |
#--------------------------------------------------------------------------- |
#--------------------------------------------------------------------------- |
2190 |
|
|
2191 |
CLASS_DIAGRAMS = YES |
CLASS_DIAGRAMS = YES |
2192 |
|
|
|
# You can define message sequence charts within doxygen comments using the \msc |
|
|
# command. Doxygen will then run the mscgen tool (see: |
|
|
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the |
|
|
# documentation. The MSCGEN_PATH tag allows you to specify the directory where |
|
|
# the mscgen tool resides. If left empty the tool is assumed to be found in the |
|
|
# default search path. |
|
|
|
|
|
MSCGEN_PATH = |
|
|
|
|
2193 |
# You can include diagrams made with dia in doxygen documentation. Doxygen will |
# You can include diagrams made with dia in doxygen documentation. Doxygen will |
2194 |
# then run dia to produce the diagram and insert it in the documentation. The |
# then run dia to produce the diagram and insert it in the documentation. The |
2195 |
# DIA_PATH tag allows you to specify the directory where the dia binary resides. |
# DIA_PATH tag allows you to specify the directory where the dia binary resides. |
2208 |
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent |
2209 |
# Bell Labs. The other options in this section have no effect if this option is |
# Bell Labs. The other options in this section have no effect if this option is |
2210 |
# set to NO |
# set to NO |
2211 |
# The default value is: YES. |
# The default value is: NO. |
2212 |
|
|
2213 |
HAVE_DOT = NO |
HAVE_DOT = NO |
2214 |
|
|
2364 |
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order |
2365 |
# to make the SVG files visible in IE 9+ (other browsers do not have this |
# to make the SVG files visible in IE 9+ (other browsers do not have this |
2366 |
# requirement). |
# requirement). |
2367 |
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd, |
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, |
|
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo, |
|
|
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo, |
|
2368 |
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and |
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and |
2369 |
# png:gdiplus:gdiplus. |
# png:gdiplus:gdiplus. |
2370 |
# The default value is: png. |
# The default value is: png. |
2417 |
|
|
2418 |
PLANTUML_JAR_PATH = |
PLANTUML_JAR_PATH = |
2419 |
|
|
2420 |
|
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a |
2421 |
|
# configuration file for plantuml. |
2422 |
|
|
2423 |
|
PLANTUML_CFG_FILE = |
2424 |
|
|
2425 |
# When using plantuml, the specified paths are searched for files specified by |
# When using plantuml, the specified paths are searched for files specified by |
2426 |
# the !include statement in a plantuml block. |
# the !include statement in a plantuml block. |
2427 |
|
|