3
3
# This file describes the settings to be used by the documentation system
4
4
# doxygen (www.doxygen.org) for a project.
6
# All text after a double hash (##) is considered a comment and is placed
7
# in front of the TAG it is preceding .
6
8
# All text after a hash (#) is considered a comment and will be ignored.
8
10
# TAG = value [value, ...]
70
72
# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
71
73
# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
72
74
# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
73
# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
74
# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
75
# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
75
# messages), Korean, Korean-en, Latvian, Lithuanian, Norwegian, Macedonian,
76
# Persian, Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic,
77
# Slovak, Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
77
79
OUTPUT_LANGUAGE = English
186
188
# The TAB_SIZE tag can be used to set the number of spaces in a tab.
187
189
# Doxygen uses this value to replace tabs by spaces in code fragments.
191
193
# This tag can be used to specify a number of aliases that acts
192
194
# as commands in the documentation. An alias has the form "name=value".
253
255
MARKDOWN_SUPPORT = YES
255
# When enabled doxygen tries to link words that correspond to documented classes,
256
# or namespaces to their corresponding documentation. Such a link can be
257
# prevented in individual cases by by putting a % sign in front of the word or
258
# globally by setting AUTOLINK_SUPPORT to NO.
257
# When enabled doxygen tries to link words that correspond to documented
258
# classes, or namespaces to their corresponding documentation. Such a link can
259
# be prevented in individual cases by by putting a % sign in front of the word
260
# or globally by setting AUTOLINK_SUPPORT to NO.
260
262
AUTOLINK_SUPPORT = YES
311
313
INLINE_GROUPED_CLASSES = NO
313
315
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
314
# unions with only public data fields will be shown inline in the documentation
315
# of the scope in which they are defined (i.e. file, namespace, or group
316
# documentation), provided this scope is documented. If set to NO (the default),
317
# structs, classes, and unions are shown on a separate page (for HTML and Man
318
# pages) or section (for LaTeX and RTF).
316
# unions with only public data fields or simple typedef fields will be shown
317
# inline in the documentation of the scope in which they are defined (i.e. file,
318
# namespace, or group documentation), provided this scope is documented. If set
319
# to NO (the default), structs, classes, and unions are shown on a separate
320
# page (for HTML and Man pages) or section (for LaTeX and RTF).
320
322
INLINE_SIMPLE_STRUCTS = NO
330
332
TYPEDEF_HIDES_STRUCT = NO
332
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
333
# determine which symbols to keep in memory and which to flush to disk.
334
# When the cache is full, less often used symbols will be written to disk.
335
# For small to medium size projects (<1000 input files) the default value is
336
# probably good enough. For larger projects a too small cache size can cause
337
# doxygen to be busy swapping symbols to and from disk most of the time
338
# causing a significant performance penalty.
339
# If the system has enough physical memory increasing the cache will improve the
340
# performance by keeping more symbols in memory. Note that the value works on
341
# a logarithmic scale so increasing the size by one will roughly double the
342
# memory usage. The cache size is given by this formula:
343
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
344
# corresponding to a cache size of 2^16 = 65536 symbols.
346
SYMBOL_CACHE_SIZE = 0
348
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
349
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
350
# their name and scope. Since this can be an expensive process and often the
351
# same symbol appear multiple times in the code, doxygen keeps a cache of
352
# pre-resolved symbols. If the cache is too small doxygen will become slower.
353
# If the cache is too large, memory is wasted. The cache size is given by this
354
# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
355
# corresponding to a cache size of 2^16 = 65536 symbols.
334
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
335
# cache is used to resolve symbols given their name and scope. Since this can
336
# be an expensive process and often the same symbol appear multiple times in
337
# the code, doxygen keeps a cache of pre-resolved symbols. If the cache is too
338
# small doxygen will become slower. If the cache is too large, memory is wasted.
339
# The cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid
340
# range is 0..9, the default is 0, corresponding to a cache size of 2^16 = 65536
357
343
LOOKUP_CACHE_SIZE = 0
363
349
# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
364
350
# documentation are documented, even if no documentation was available.
365
351
# Private class members and static file members will be hidden unless
366
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
352
# the EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES
757
743
# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
758
744
# input file. Doxygen will then use the output that the filter program writes
759
745
# to standard output.
760
# If FILTER_PATTERNS is specified, this tag will be
746
# If FILTER_PATTERNS is specified, this tag will be ignored.
747
# Note that the filter must not add or remove lines; it is applied before the
748
# code is scanned, but not when the output code is generated. If lines are added
749
# or removed, the anchors will not be placed correctly.
788
776
FILTER_SOURCE_PATTERNS =
790
778
# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
791
# is part of the input, its contents will be placed on the main page (index.html).
792
# This can be useful if you have a project on for instance GitHub and want reuse
793
# the introduction page also for the doxygen output.
779
# is part of the input, its contents will be placed on the main page
780
# (index.html). This can be useful if you have a project on for instance GitHub
781
# and want reuse the introduction page also for the doxygen output.
795
783
USE_MDFILE_AS_MAINPAGE =
935
923
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
936
924
# other source files which should be copied to the HTML output directory. Note
937
925
# that these files will be copied to the base HTML output directory. Use the
938
# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
926
# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
939
927
# files. In the HTML_STYLESHEET file, use the file name only. Also note that
940
928
# the files will be copied as-is; there are no commands or markers available.
1204
1192
USE_MATHJAX = NO
1206
1194
# When MathJax is enabled you can set the default output format to be used for
1207
# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1195
# the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
1208
1196
# SVG. The default value is HTML-CSS, which is slower, but has the best
1209
1197
# compatibility.
1228
1216
MATHJAX_EXTENSIONS =
1218
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript
1219
# pieces of code that will be used on startup of the MathJax code.
1230
1223
# When the SEARCHENGINE tag is enabled doxygen will generate a search box
1231
1224
# for the HTML output. The underlying search engine uses javascript
1232
1225
# and DHTML and should work on any modern browser. Note that when using
1252
1245
# which needs to be processed by an external indexer. Doxygen will invoke an
1253
1246
# external search engine pointed to by the SEARCHENGINE_URL option to obtain
1254
1247
# the search results. Doxygen ships with an example indexer (doxyindexer) and
1255
# search engine (doxysearch.cgi) which are based on the open source search engine
1256
# library Xapian. See the manual for configuration details.
1248
# search engine (doxysearch.cgi) which are based on the open source search
1249
# engine library Xapian. See the manual for configuration details.
1258
1251
EXTERNAL_SEARCH = NO
1325
1318
# The PAPER_TYPE tag can be used to set the paper type that is used
1326
1319
# by the printer. Possible values are: a4, letter, legal and
1327
# executive. If left blank a4wide will be used.
1320
# executive. If left blank a4 will be used.
1329
1322
PAPER_TYPE = a4wide
1343
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images
1344
# or other source files which should be copied to the LaTeX output directory.
1345
# Note that the files will be copied as-is; there are no commands or markers
1350
1350
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
1351
1351
# is prepared for conversion to pdf (using ps2pdf). The pdf file will
1352
1352
# contain links (just like the HTML output) instead of page references
1492
1492
XML_PROGRAMLISTING = YES
1494
1494
#---------------------------------------------------------------------------
1495
# configuration options related to the DOCBOOK output
1496
#---------------------------------------------------------------------------
1498
# If the GENERATE_DOCBOOK tag is set to YES Doxygen will generate DOCBOOK files
1499
# that can be used to generate PDF.
1501
GENERATE_DOCBOOK = NO
1503
# The DOCBOOK_OUTPUT tag is used to specify where the DOCBOOK pages will be put.
1504
# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1505
# front of it. If left blank docbook will be used as the default path.
1507
DOCBOOK_OUTPUT = docbook
1509
#---------------------------------------------------------------------------
1495
1510
# configuration options for the AutoGen Definitions output
1496
1511
#---------------------------------------------------------------------------
1641
1656
EXTERNAL_GROUPS = YES
1658
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed
1659
# in the related pages index. If set to NO, only the current project's
1660
# pages will be listed.
1662
EXTERNAL_PAGES = YES
1643
1664
# The PERL_PATH should be the absolute path and name of the perl script
1644
1665
# interpreter (i.e. the result of `which perl').
1694
1715
# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
1695
1716
# directory containing the font.
1697
DOT_FONTNAME = FreeSans
1699
1720
# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
1700
1721
# The default size is 10pt.
1736
1757
# the class node. If there are many fields or methods and many nodes the
1737
1758
# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
1738
1759
# threshold limits the number of items for each type to make the size more
1739
# managable. Set this to 0 for no limit. Note that the threshold may be
1760
# manageable. Set this to 0 for no limit. Note that the threshold may be
1740
1761
# exceeded by 50% before the limit is enforced.
1742
1763
UML_LIMIT_NUM_FIELDS = 10
added
removed
cmake/Doxyfile.in
