|
1 | | -# Doxyfile 1.8.17 |
| 1 | +# Doxyfile 1.8.20 |
2 | 2 |
|
3 | 3 | # This file describes the settings to be used by the documentation system |
4 | 4 | # doxygen (www.doxygen.org) for a project. |
@@ -227,6 +227,14 @@ QT_AUTOBRIEF = NO |
227 | 227 |
|
228 | 228 | MULTILINE_CPP_IS_BRIEF = NO |
229 | 229 |
|
| 230 | +# By default Python docstrings are displayed as preformatted text and doxygen's |
| 231 | +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the |
| 232 | +# doxygen's special commands can be used and the contents of the docstring |
| 233 | +# documentation blocks is shown as doxygen documentation. |
| 234 | +# The default value is: YES. |
| 235 | + |
| 236 | +PYTHON_DOCSTRING = YES |
| 237 | + |
230 | 238 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the |
231 | 239 | # documentation from any documented member that it re-implements. |
232 | 240 | # The default value is: YES. |
@@ -266,12 +274,6 @@ ALIASES = "startfnlist=\page fnoverview ^^<dl>" \ |
266 | 274 | "utility{1}=\page fnoverview ^^<dt>`\1()`</dt><dd>\copybrief \1 </dd>" \ |
267 | 275 | "alias{1}=\utility{\1}^^^^\var \1^^\brief " |
268 | 276 |
|
269 | | -# This tag can be used to specify a number of word-keyword mappings (TCL only). |
270 | | -# A mapping has the form "name=value". For example adding "class=itcl::class" |
271 | | -# will allow you to use the command class in the itcl::class meaning. |
272 | | - |
273 | | -TCL_SUBST = |
274 | | - |
275 | 277 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources |
276 | 278 | # only. Doxygen will then generate output that is more tailored for C. For |
277 | 279 | # instance, some of the names that are used will be different. The list of all |
@@ -313,13 +315,13 @@ OPTIMIZE_OUTPUT_SLICE = NO |
313 | 315 | # extension. Doxygen has a built-in mapping, but you can override or extend it |
314 | 316 | # using this tag. The format is ext=language, where ext is a file extension, and |
315 | 317 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, |
316 | | -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, |
| 318 | +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, |
317 | 319 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: |
318 | 320 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser |
319 | 321 | # tries to guess whether the code is fixed or free formatted code, this is the |
320 | | -# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat |
321 | | -# .inc files as Fortran files (default is PHP), and .f files as C (default is |
322 | | -# Fortran), use: inc=Fortran f=C. |
| 322 | +# default for Fortran type files). For instance to make doxygen treat .inc files |
| 323 | +# as Fortran files (default is PHP), and .f files as C (default is Fortran), |
| 324 | +# use: inc=Fortran f=C. |
323 | 325 | # |
324 | 326 | # Note: For files without extension you can use no_extension as a placeholder. |
325 | 327 | # |
@@ -458,6 +460,19 @@ TYPEDEF_HIDES_STRUCT = NO |
458 | 460 |
|
459 | 461 | LOOKUP_CACHE_SIZE = 0 |
460 | 462 |
|
| 463 | +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use |
| 464 | +# during processing. When set to 0 doxygen will based this on the number of |
| 465 | +# cores available in the system. You can set it explicitly to a value larger |
| 466 | +# than 0 to get more control over the balance between CPU load and processing |
| 467 | +# speed. At this moment only the input processing can be done using multiple |
| 468 | +# threads. Since this is still an experimental feature the default is set to 1, |
| 469 | +# which efficively disables parallel processing. Please report any issues you |
| 470 | +# encounter. Generating dot graphs in parallel is controlled by the |
| 471 | +# DOT_NUM_THREADS setting. |
| 472 | +# Minimum value: 0, maximum value: 32, default value: 1. |
| 473 | + |
| 474 | +NUM_PROC_THREADS = 1 |
| 475 | + |
461 | 476 | #--------------------------------------------------------------------------- |
462 | 477 | # Build related configuration options |
463 | 478 | #--------------------------------------------------------------------------- |
@@ -562,7 +577,7 @@ INTERNAL_DOCS = NO |
562 | 577 | # names in lower-case letters. If set to YES, upper-case letters are also |
563 | 578 | # allowed. This is useful if you have classes or files whose names only differ |
564 | 579 | # in case and if your file system supports case sensitive file names. Windows |
565 | | -# (including Cygwin) ands Mac users are advised to set this option to NO. |
| 580 | +# (including Cygwin) and Mac users are advised to set this option to NO. |
566 | 581 | # The default value is: system dependent. |
567 | 582 |
|
568 | 583 | CASE_SENSE_NAMES = YES |
@@ -865,7 +880,7 @@ INPUT_ENCODING = UTF-8 |
865 | 880 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, |
866 | 881 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), |
867 | 882 | # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen |
868 | | -# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, |
| 883 | +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, |
869 | 884 | # *.vhdl, *.ucf, *.qsf and *.ice. |
870 | 885 |
|
871 | 886 | FILE_PATTERNS = *.c \ |
@@ -1389,7 +1404,7 @@ CHM_FILE = |
1389 | 1404 | HHC_LOCATION = |
1390 | 1405 |
|
1391 | 1406 | # The GENERATE_CHI flag controls if a separate .chi index file is generated |
1392 | | -# (YES) or that it should be included in the master .chm file (NO). |
| 1407 | +# (YES) or that it should be included in the main .chm file (NO). |
1393 | 1408 | # The default value is: NO. |
1394 | 1409 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. |
1395 | 1410 |
|
@@ -1551,6 +1566,17 @@ TREEVIEW_WIDTH = 250 |
1551 | 1566 |
|
1552 | 1567 | EXT_LINKS_IN_WINDOW = NO |
1553 | 1568 |
|
| 1569 | +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg |
| 1570 | +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see |
| 1571 | +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for |
| 1572 | +# the HTML output. These images will generally look nicer at scaled resolutions. |
| 1573 | +# Possible values are: png (the default) and svg (looks nicer but requires the |
| 1574 | +# pdf2svg or inkscape tool). |
| 1575 | +# The default value is: png. |
| 1576 | +# This tag requires that the tag GENERATE_HTML is set to YES. |
| 1577 | + |
| 1578 | +HTML_FORMULA_FORMAT = png |
| 1579 | + |
1554 | 1580 | # Use this tag to change the font size of LaTeX formulas included as images in |
1555 | 1581 | # the HTML documentation. When you change the font size after a successful |
1556 | 1582 | # doxygen run you need to manually remove any form_*.png images from the HTML |
@@ -1606,7 +1632,7 @@ MATHJAX_FORMAT = HTML-CSS |
1606 | 1632 | # Content Delivery Network so you can quickly see the result without installing |
1607 | 1633 | # MathJax. However, it is strongly recommended to install a local copy of |
1608 | 1634 | # MathJax from https://www.mathjax.org before deployment. |
1609 | | -# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. |
| 1635 | +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. |
1610 | 1636 | # This tag requires that the tag USE_MATHJAX is set to YES. |
1611 | 1637 |
|
1612 | 1638 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest |
@@ -1845,9 +1871,11 @@ LATEX_EXTRA_FILES = |
1845 | 1871 |
|
1846 | 1872 | PDF_HYPERLINKS = YES |
1847 | 1873 |
|
1848 | | -# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate |
1849 | | -# the PDF file directly from the LaTeX files. Set this option to YES, to get a |
1850 | | -# higher quality PDF documentation. |
| 1874 | +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as |
| 1875 | +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX |
| 1876 | +# files. Set this option to YES, to get a higher quality PDF documentation. |
| 1877 | +# |
| 1878 | +# See also section LATEX_CMD_NAME for selecting the engine. |
1851 | 1879 | # The default value is: YES. |
1852 | 1880 | # This tag requires that the tag GENERATE_LATEX is set to YES. |
1853 | 1881 |
|
|
0 commit comments