diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..9cdf2d670 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "pip" # See documentation for possible values + directory: "/docs/.sphinx" # Location of package manifests + open-pull-requests-limit: 10 + schedule: + interval: "daily" diff --git a/.gitignore b/.gitignore index e7391f1f2..78fbc8a40 100644 --- a/.gitignore +++ b/.gitignore @@ -6,9 +6,6 @@ doc/html/ doc/xml/ doc/latex/ doc/*.tag -docs/_build/ -docs/api/ -docs/docBin/ # Created by https://www.gitignore.io/api/c++,cmake diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 11ace5d6b..d93eb663b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -8,6 +8,7 @@ include: file: - /defaults.yaml - /deps-cmake.yaml + - /deps-docs.yaml - /deps-rocm.yaml - /gpus-rocm.yaml - /rules.yaml @@ -159,17 +160,10 @@ test:package: - $SUDO_CMD dpkg -r rocprim-dev test:doc: - image: sphinxdoc/sphinx-latexpdf - needs: [] stage: test extends: + - .build:docs - .rules:test - before_script: - - $SUDO_CMD apt update -qq - - $SUDO_CMD apt install -y -qq doxygen - - $SUDO_CMD pip3 install sphinx_rtd_theme breathe exhale - script: - - bash -x $CI_PROJECT_DIR/docs/run_doc.sh test: stage: test diff --git a/.jenkins/staticanalysis.groovy b/.jenkins/staticanalysis.groovy index 10d583ab0..7d2cf06a3 100644 --- a/.jenkins/staticanalysis.groovy +++ b/.jenkins/staticanalysis.groovy @@ -12,28 +12,6 @@ import java.nio.file.Path def runCompileCommand(platform, project, jobName, boolean debug=false) { project.paths.construct_build_prefix() - - def command = """#!/usr/bin/env bash - set -x - ${project.paths.project_build_prefix}/docs/run_doc.sh - """ - - try - { - platform.runCommand(this, command) - } - catch(e) - { - throw e - } - - publishHTML([allowMissing: false, - alwaysLinkToLastBuild: false, - keepAll: false, - reportDir: "${project.paths.project_build_prefix}/docs/_build/html", - reportFiles: "index.html", - reportName: "Documentation", - reportTitles: "Documentation"]) } def runCI = diff --git a/.readthedocs.yml b/.readthedocs.yml index 3d4ddb226..c7294f37f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,24 +1,14 @@ -# .readthedocs.yml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required version: 2 -# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml +formats: [htmlzip] -# Optionally build your docs in additional formats such as PDF and ePub -formats: all - -# Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 + version: 3.8 install: - - requirements: docs/requirements.txt - + - requirements: docs/.sphinx/requirements.txt diff --git a/CHANGELOG.md b/CHANGELOG.md index 45df1b507..efb0ad688 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,13 @@ Full documentation for rocThrust is available at [https://rocthrust.readthedocs.io/en/latest/](https://rocthrust.readthedocs.io/en/latest/) -## (Unreleased) rocThrust 2.18.0 for ROCm 5.6 +## rocThrust 2.18.0 for ROCm 5.6 ### Fixed - `lower_bound`, `upper_bound`, and `binary_search` failed to compile for certain types. +### Changed +- Updated `docs` directory structure to match the standard of [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core). -## (Unreleased) rocThrust 2.17.0 for ROCm 5.5 +## rocThrust 2.17.0 for ROCm 5.5 ### Added - Updated to match upstream Thrust 1.17.2 ### Fixed diff --git a/CMakeLists.txt b/CMakeLists.txt index 92f1e598d..6372dfd9a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -133,7 +133,7 @@ if(BUILD_ADDRESS_SANITIZER) endif() # Setup VERSION -rocm_setup_version(VERSION "2.10.9") +rocm_setup_version(VERSION "2.18.0") # Print configuration summary include(cmake/Summary.cmake) diff --git a/README.md b/README.md index 8cb25264d..354a1f79a 100644 --- a/README.md +++ b/README.md @@ -221,6 +221,23 @@ make -j4 Documentation is available [here](https://rocthrust.readthedocs.io/en/latest/). +It can also be build using the following commands: + +```shell +# Go to rocThrust docs directory +cd rocThrust; cd docs + +# Install Python dependencies +python3 -m pip install -r .sphinx/requirements.txt + +# Build the documentation +python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html + +# For e.g. serve the HTML docs locally +cd _build/html +python3 -m http.server +``` + ## Support Bugs and feature requests can be reported through [the issue tracker](https://github.com/ROCmSoftwarePlatform/rocThrust/issues). diff --git a/docs/Doxyfile b/docs/.doxygen/Doxyfile similarity index 96% rename from docs/Doxyfile rename to docs/.doxygen/Doxyfile index be287b487..3ccc82162 100644 --- a/docs/Doxyfile +++ b/docs/.doxygen/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = thrust +PROJECT_NAME = rocThrust # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -51,7 +51,7 @@ PROJECT_BRIEF = "prototype interfaces compatible with ROCm platform and # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = ./rocm.jpg +PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -171,7 +171,7 @@ STRIP_FROM_PATH = .. # specify the list of include paths that are normally passed to the compiler # using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't @@ -238,13 +238,13 @@ TAB_SIZE = 4 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. -ALIASES = +ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. -TCL_SUBST = +TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For @@ -291,7 +291,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. -EXTENSION_MAPPING = +EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable @@ -641,7 +641,7 @@ GENERATE_DEPRECATEDLIST= YES # sections, marked by \if ... \endif and \cond # ... \endcond blocks. -ENABLED_SECTIONS = +ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the @@ -683,7 +683,7 @@ SHOW_NAMESPACES = YES # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated @@ -696,7 +696,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -706,7 +706,7 @@ LAYOUT_FILE = # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. -CITE_BIB_FILES = +CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages @@ -765,7 +765,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -777,7 +777,12 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../thrust +INPUT = ../../thrust \ + ../../thrust/async \ + ../../thrust/iterator \ + ../../thrust/mr \ + ../../thrust/random \ + ../../thrust/system # This tag can be used to specify the character encoding of the source files @@ -803,48 +808,7 @@ INPUT_ENCODING = UTF-8 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, # *.vhdl, *.ucf, *.qsf, *.as and *.js. -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.f90 \ - *.f \ - *.for \ - *.tcl \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf \ - *.as \ - *.js +FILE_PATTERNS = # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -859,7 +823,7 @@ RECURSIVE = NO # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded @@ -875,7 +839,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -886,13 +850,13 @@ EXCLUDE_PATTERNS = # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = +EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -912,7 +876,7 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = +IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -929,7 +893,7 @@ IMAGE_PATH = # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. -INPUT_FILTER = +INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the @@ -938,7 +902,7 @@ INPUT_FILTER = # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. -FILTER_PATTERNS = +FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for @@ -953,7 +917,7 @@ FILTER_SOURCE_FILES = NO # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. -FILTER_SOURCE_PATTERNS = +FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page @@ -1065,7 +1029,7 @@ CLANG_ASSISTED_PARSING = NO # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. -CLANG_OPTIONS = +CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index @@ -1091,7 +1055,7 @@ COLS_IN_ALPHA_INDEX = 5 # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output @@ -1135,7 +1099,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1145,7 +1109,7 @@ HTML_HEADER = # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = +HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1157,7 +1121,7 @@ HTML_FOOTER = # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_STYLESHEET = +HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets @@ -1170,7 +1134,7 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1180,7 +1144,7 @@ HTML_EXTRA_STYLESHEET = # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to @@ -1309,7 +1273,7 @@ GENERATE_HTMLHELP = NO # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_FILE = +CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, @@ -1317,7 +1281,7 @@ CHM_FILE = # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HHC_LOCATION = +HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). @@ -1330,7 +1294,7 @@ GENERATE_CHI = NO # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it @@ -1361,7 +1325,7 @@ GENERATE_QHP = NO # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = +QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace @@ -1386,7 +1350,7 @@ QHP_VIRTUAL_FOLDER = doc # filters). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom @@ -1394,21 +1358,21 @@ QHP_CUST_FILTER_NAME = # filters). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_ATTRS = +QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. -QHG_LOCATION = +QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To @@ -1541,7 +1505,7 @@ MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_EXTENSIONS = +MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site @@ -1549,7 +1513,7 @@ MATHJAX_EXTENSIONS = # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_CODEFILE = +MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and @@ -1609,7 +1573,7 @@ EXTERNAL_SEARCH = NO # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. -SEARCHENGINE_URL = +SEARCHENGINE_URL = # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # search data is written to a file for indexing by an external tool. With the @@ -1625,7 +1589,7 @@ SEARCHDATA_FILE = searchdata.xml # projects and redirect the results back to the right project. # This tag requires that the tag SEARCHENGINE is set to YES. -EXTERNAL_SEARCH_ID = +EXTERNAL_SEARCH_ID = # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen # projects other than the one defined by this configuration file, but that are @@ -1635,7 +1599,7 @@ EXTERNAL_SEARCH_ID = # EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... # This tag requires that the tag SEARCHENGINE is set to YES. -EXTRA_SEARCH_MAPPINGS = +EXTRA_SEARCH_MAPPINGS = #--------------------------------------------------------------------------- # Configuration options related to the LaTeX output @@ -1699,7 +1663,7 @@ PAPER_TYPE = a4 # If left blank no extra packages will be included. # This tag requires that the tag GENERATE_LATEX is set to YES. -EXTRA_PACKAGES = +EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for the # generated LaTeX document. The header should contain everything until the first @@ -1715,7 +1679,7 @@ EXTRA_PACKAGES = # to HTML_HEADER. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_HEADER = +LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the # generated LaTeX document. The footer should contain everything after the last @@ -1726,7 +1690,7 @@ LATEX_HEADER = # Note: Only use a user-defined footer if you know what you are doing! # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_FOOTER = +LATEX_FOOTER = # The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined # LaTeX style sheets that are included after the standard style sheets created @@ -1737,7 +1701,7 @@ LATEX_FOOTER = # list). # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_STYLESHEET = # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output @@ -1745,7 +1709,7 @@ LATEX_EXTRA_STYLESHEET = # markers available. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_EXTRA_FILES = +LATEX_EXTRA_FILES = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is # prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will @@ -1845,14 +1809,14 @@ RTF_HYPERLINKS = NO # default style sheet that doxygen normally uses. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is # similar to doxygen's config file. A template extensions file can be generated # using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = # If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code # with syntax highlighting in the RTF output. @@ -1897,7 +1861,7 @@ MAN_EXTENSION = .3 # MAN_EXTENSION with the initial . removed. # This tag requires that the tag GENERATE_MAN is set to YES. -MAN_SUBDIR = +MAN_SUBDIR = # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it # will generate one additional man file for each entity documented in the real @@ -1916,7 +1880,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = YES +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -2010,7 +1974,7 @@ PERLMOD_PRETTY = YES # overwrite each other's variables. # This tag requires that the tag GENERATE_PERLMOD is set to YES. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor @@ -2051,7 +2015,7 @@ SEARCH_INCLUDES = NO # preprocessor. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = +INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the @@ -2059,7 +2023,7 @@ INCLUDE_PATH = # used. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that are # defined before the preprocessor is started (similar to the -D option of e.g. @@ -2089,7 +2053,7 @@ PREDEFINED = THRUST_NOEXCEPT=noexcept \ # definition found in the source code. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # remove all references to function-like macros that are alone on a line, have @@ -2118,13 +2082,13 @@ SKIP_FUNCTION_MACROS = NO # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to # external documentation" for more information about the usage of tag files. -GENERATE_TAGFILE = +GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES, all external class will be listed in # the class index. If set to NO, only the inherited external classes will be @@ -2147,12 +2111,6 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES -# 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 - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- @@ -2166,21 +2124,12 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = NO -# 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 = - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. # If left empty dia is assumed to be found in the default search path. -DIA_PATH = +DIA_PATH = # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. @@ -2229,7 +2178,7 @@ DOT_FONTSIZE = 10 # the path where dot can find it using this tag. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTPATH = +DOT_FONTPATH = # If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for # each documented class showing the direct and indirect inheritance relations. @@ -2373,26 +2322,26 @@ INTERACTIVE_SVG = NO # found. If left blank, it is assumed the dot tool can be found in the path. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_PATH = +DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the \dotfile # command). # This tag requires that the tag HAVE_DOT is set to YES. -DOTFILE_DIRS = +DOTFILE_DIRS = # The MSCFILE_DIRS tag can be used to specify one or more directories that # contain msc files that are included in the documentation (see the \mscfile # command). -MSCFILE_DIRS = +MSCFILE_DIRS = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile # command). -DIAFILE_DIRS = +DIAFILE_DIRS = # When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the # path where java can find the plantuml.jar file. If left blank, it is assumed @@ -2400,12 +2349,12 @@ DIAFILE_DIRS = # generate a warning when it encounters a \startuml command in this case and # will not generate output for the diagram. -PLANTUML_JAR_PATH = +PLANTUML_JAR_PATH = # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block. -PLANTUML_INCLUDE_PATH = +PLANTUML_INCLUDE_PATH = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..e4fcb6a80 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,7 @@ +/_build +/_doxygen +/_images +/_static +/_templates +/.doxygen/docBin +/.sphinx/_toc.yml diff --git a/docs/.sphinx/_toc.yml.in b/docs/.sphinx/_toc.yml.in new file mode 100644 index 000000000..8186d2985 --- /dev/null +++ b/docs/.sphinx/_toc.yml.in @@ -0,0 +1,23 @@ +# Anywhere {branch} is used, the branch name will be substituted. +# These comments will also be removed. +defaults: + numbered: False +root: index +subtrees: +- caption: Setup + entries: + - file: setup/requirements + - file: setup/cmake_options + - file: setup/installing +- caption: API + entries: + - file: cpp_api +- caption: Releases + entries: + - file: releases/versioning + - file: releases/releases +- caption: Contributing + entries: + - file: contributing/contributing + - file: contributing/submitting_a_pr + - file: contributing/release_process diff --git a/docs/.sphinx/requirements.in b/docs/.sphinx/requirements.in new file mode 100644 index 000000000..d06afe41a --- /dev/null +++ b/docs/.sphinx/requirements.in @@ -0,0 +1 @@ +rocm-docs-core==0.13.1 diff --git a/docs/.sphinx/requirements.txt b/docs/.sphinx/requirements.txt new file mode 100644 index 000000000..152e8a2e3 --- /dev/null +++ b/docs/.sphinx/requirements.txt @@ -0,0 +1,145 @@ +# +# This file is autogenerated by pip-compile with Python 3.8 +# by the following command: +# +# pip-compile requirements.in +# +accessible-pygments==0.0.3 + # via pydata-sphinx-theme +alabaster==0.7.13 + # via sphinx +babel==2.12.1 + # via + # pydata-sphinx-theme + # sphinx +beautifulsoup4==4.11.2 + # via pydata-sphinx-theme +breathe==4.34.0 + # via rocm-docs-core +certifi==2022.12.7 + # via requests +cffi==1.15.1 + # via + # cryptography + # pynacl +charset-normalizer==3.1.0 + # via requests +click==8.1.3 + # via sphinx-external-toc +cryptography==40.0.2 + # via pyjwt +deprecated==1.2.13 + # via pygithub +docutils==0.19 + # via + # breathe + # myst-parser + # pydata-sphinx-theme + # sphinx +fastjsonschema==2.16.3 + # via rocm-docs-core +gitdb==4.0.10 + # via gitpython +gitpython==3.1.31 + # via rocm-docs-core +idna==3.4 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.2 + # via + # myst-parser + # sphinx +linkify-it-py==1.0.3 + # via myst-parser +markdown-it-py==2.2.0 + # via + # mdit-py-plugins + # myst-parser +markupsafe==2.1.2 + # via jinja2 +mdit-py-plugins==0.3.5 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-parser[linkify]==1.0.0 + # via rocm-docs-core +packaging==23.0 + # via + # pydata-sphinx-theme + # sphinx +pycparser==2.21 + # via cffi +pydata-sphinx-theme==0.13.3 + # via + # rocm-docs-core + # sphinx-book-theme +pygithub==1.58.1 + # via rocm-docs-core +pygments==2.14.0 + # via + # accessible-pygments + # pydata-sphinx-theme + # sphinx +pyjwt[crypto]==2.6.0 + # via pygithub +pynacl==1.5.0 + # via pygithub +pyyaml==6.0 + # via + # myst-parser + # rocm-docs-core + # sphinx-external-toc +requests==2.31.0 + # via + # pygithub + # sphinx +rocm-docs-core==0.13.1 + # via -r requirements.in +smmap==5.0.0 + # via gitdb +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.4 + # via beautifulsoup4 +sphinx==5.3.0 + # via + # breathe + # myst-parser + # pydata-sphinx-theme + # rocm-docs-core + # sphinx-book-theme + # sphinx-copybutton + # sphinx-design + # sphinx-external-toc + # sphinx-notfound-page +sphinx-book-theme==1.0.1 + # via rocm-docs-core +sphinx-copybutton==0.5.1 + # via rocm-docs-core +sphinx-design==0.4.1 + # via rocm-docs-core +sphinx-external-toc==0.3.1 + # via rocm-docs-core +sphinx-notfound-page==0.8.3 + # via rocm-docs-core +sphinxcontrib-applehelp==1.0.4 + # via sphinx +sphinxcontrib-devhelp==1.0.2 + # via sphinx +sphinxcontrib-htmlhelp==2.0.1 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.3 + # via sphinx +sphinxcontrib-serializinghtml==1.1.5 + # via sphinx +typing-extensions==4.5.0 + # via pydata-sphinx-theme +uc-micro-py==1.0.1 + # via linkify-it-py +urllib3==1.26.15 + # via requests +wrapt==1.15.0 + # via deprecated diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index b1d7bd112..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,24 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = rocThrust -SOURCEDIR = . -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile clean - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -clean: - rm -rf docBin/ api/ - @$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py index a3fc96c20..c165fe72e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,205 +1,14 @@ -# -*- coding: utf-8 -*- +# Configuration file for the Sphinx documentation builder. # -# rocThrust documentation build configuration file, created by -# sphinx-quickstart on Mon Jan 8 16:34:42 2018. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - -import os -import sys -import subprocess - -read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.mathjax', 'breathe', 'exhale'] -breathe_projects = { "rocThrust": "./docBin/xml" } -breathe_default_project = "rocThrust" - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'rocThrust' -copyright = u'2008-2013, NVIDIA CORPORATION; Modifications Copyright 2022 Advanced Micro Devices' -author = u'Advanced Micro Devices' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = u'0.8' -# The full version, including alpha/beta/rc tags. -release = u'0.8' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -# html_theme = 'alabaster' - -if read_the_docs_build: - html_theme = 'default' -else: - import sphinx_rtd_theme - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -# html_sidebars = { -# '**': [ -# 'relations.html', # needs 'show_related': True theme option to display -# 'searchbox.html', -# ] -# } - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'rocThrustdoc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'rocThrust.tex', u'rocThrust Documentation', - u'Advanced Micro Devices', 'manual'), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'rocThrust', u'rocThrust Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'rocThrust', u'rocThrust Documentation', - author, 'rocThrust', 'One line description of project.', - 'Miscellaneous'), -] - - +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -# Setup the exhale extension -exhale_args = { - # These arguments are required - "containmentFolder": "./api", - "rootFileName": "library_root.rst", - "rootFileTitle": "Library API", - "doxygenStripFromPath": "..", - # Suggested optional arguments - "createTreeView": True, - # TIP: if using the sphinx-bootstrap-theme, you need - # "treeViewIsBootstrap": True, - "exhaleExecutesDoxygen": True, - "exhaleUseDoxyfile": True - # "exhaleDoxygenStdin": "INPUT = ../../thrust" -} +from rocm_docs import ROCmDocs -# Tell sphinx what the primary language being documented is. -primary_domain = 'cpp' -cpp_id_attributes = ["__global__", "__device__", "__host__"] -cpp_paren_attributes = ["__declspec"] +docs_core = ROCmDocs("rocThrust Documentation") +docs_core.run_doxygen() +docs_core.setup() -# Tell sphinx what the pygments highlight language should be. -highlight_language = 'cpp' +for sphinx_var in ROCmDocs.SPHINX_VARS: + globals()[sphinx_var] = getattr(docs_core, sphinx_var) diff --git a/docs/github_pages/contributing.md b/docs/contributing/contributing.md similarity index 100% rename from docs/github_pages/contributing.md rename to docs/contributing/contributing.md diff --git a/docs/github_pages/contributing/release_process.md b/docs/contributing/release_process.md similarity index 100% rename from docs/github_pages/contributing/release_process.md rename to docs/contributing/release_process.md diff --git a/docs/github_pages/contributing/submitting_a_pr.md b/docs/contributing/submitting_a_pr.md similarity index 100% rename from docs/github_pages/contributing/submitting_a_pr.md rename to docs/contributing/submitting_a_pr.md diff --git a/docs/cpp_api.rst b/docs/cpp_api.rst new file mode 100644 index 000000000..a112e78c4 --- /dev/null +++ b/docs/cpp_api.rst @@ -0,0 +1,60 @@ +=================== +API Reference Guide +=================== + +This chapter describes the rocThrust C++ API. + +Memory Management +================= +.. doxygengroup:: memory_management + :inner: + +Iterators +========= +.. doxygengroup:: iterators + :inner: + +Algorithms +========== +.. doxygengroup:: algorithms + :inner: + +Numerics +======== +.. doxygengroup:: numerics + :inner: + +Containers +========== +.. doxygengroup:: containers + :inner: + +Parallel Execution Policies +=========================== +.. doxygengroup:: execution_policies + :inner: + +Function Objects +================ +.. doxygengroup:: function_objects + :inner: + +Container Classes +================= +.. doxygengroup:: container_classes + :inner: + +Utility +======= +.. doxygengroup:: utility + :inner: + +Random Number Generation +======================== +.. doxygengroup:: random + :inner: + +System +====== +.. doxygengroup:: system + :inner: diff --git a/docs/doxybook/config.json b/docs/doxybook/config.json deleted file mode 100644 index 56b7a238b..000000000 --- a/docs/doxybook/config.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "baseUrl": "{{ site.baseurl }}/api/", - "copyImages": true, - "fileExt": "md", - "filesFilter": [], - "folderClassesName": "classes", - "folderExamplesName": "examples", - "folderFilesName": "files", - "folderGroupsName": "groups", - "folderNamespacesName": "namespaces", - "folderRelatedPagesName": "pages", - "imagesFolder": "images", - "indexClassesName": "index_classes", - "indexClassesTitle": "Classes", - "indexExamplesName": "index_examples", - "indexExamplesTitle": "Examples", - "indexFilesName": "index_files", - "indexFilesTitle": "Files", - "indexGroupsName": "index_groups", - "indexGroupsTitle": "Groups", - "indexInFolders": false, - "indexNamespacesName": "index_namespaces", - "indexNamespacesTitle": "namespaces", - "indexRelatedPagesName": "index_pages", - "indexRelatedPagesTitle": "pages", - "linkLowercase": true, - "linkAndInlineCodeAsHTML": true, - "linkSuffix": ".html", - "mainPageInRoot": false, - "mainPageName": "indexpage", - "sort": false, - "templateIndexClasses": "index_classes", - "templateIndexExamples": "index_examples", - "templateIndexFiles": "index_files", - "templateIndexGroups": "index_groups", - "templateIndexNamespaces": "index_namespaces", - "templateIndexRelatedPages": "index_pages", - "templateKindClass": "kind_class", - "templateKindDir": "kind_file", - "templateKindExample": "kind_page", - "templateKindFile": "kind_file", - "templateKindGroup": "kind_nonclass", - "templateKindInterface": "kind_class", - "templateKindNamespace": "kind_nonclass", - "templateKindPage": "kind_page", - "templateKindStruct": "kind_class", - "templateKindUnion": "kind_class", - "useFolders": true -} diff --git a/docs/doxybook/templates/class_members.tmpl b/docs/doxybook/templates/class_members.tmpl deleted file mode 100644 index cb5f65f38..000000000 --- a/docs/doxybook/templates/class_members.tmpl +++ /dev/null @@ -1,210 +0,0 @@ -{%- if exists("publicClasses") or exists("publicTypes") or exists("publicAttributes") or exists("publicFunctions") or exists("friends") -%} - {%- set has_public_members = true -%} -{%- endif -%} -{%- if exists("protectedClasses") or exists("protectedTypes") or exists("protectedAttributes") or exists("protectedFunctions") -%} - {%- set has_protected_members = true -%} -{%- endif -%} -{%- if exists("baseClasses") -%} - {%- for base in baseClasses -%} - {%- if existsIn(base, "publicClasses") or existsIn(base, "publicTypes") or existsIn(base, "publicAttributes") or existsIn(base, "publicFunctions") or existsIn(base, "friends") -%} - {%- set has_public_members = true -%} - {%- endif -%} - {%- if existsIn(base, "protectedClasses") or existsIn(base, "protectedTypes") or existsIn(base, "protectedAttributes") or existsIn(base, "protectedFunctions") -%} - {%- set has_protected_members = true -%} - {%- endif -%} - {%- endfor -%} -{%- endif -%} - -{%- if exists("includes") -%} - #include {{includes}}{{ noop() -}} -
-{%- endif -%} -{%- include "synopsis_template_parameters.tmpl" -%} -{%- include "synopsis_kind.tmpl" -%}{% include "name_qualified.tmpl" %} { -{%- set synopsis_indent_width = 2 -%} -{%- set names_qualified = false -%} -{%- if default(has_public_members, false) -%} - public:{{- noop() -}} -{%- endif -%} -{%- if exists("publicTypes") -%} - {%- for child in publicTypes -%} - {%- include "synopsis_type.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "publicTypes") -%} - {%- for child in base.publicTypes -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_type.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("publicClasses") -%} - {%- for child in publicClasses -%} - {%- include "synopsis_class.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "publicClasses") -%} - {%- for child in base.publicClasses -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_class.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("friends") -%} - {%- for child in friends -%} - {%- if child.type == "class" or child.type == "struct" -%} - {%- include "synopsis_friend_class.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endif -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "friends") -%} - {%- for child in base.friends -%} - {%- if child.type == "class" or child.type == "struct" -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_friend_class.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endif -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("publicAttributes") -%} - {%- for child in publicAttributes -%} - {%- include "synopsis_variable.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "publicAttributes") -%} - {%- for child in base.publicAttributes -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_variable.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("publicFunctions") -%} - {%- for child in publicFunctions -%} - {%- include "synopsis_function.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "publicFunctions") -%} - {%- for child in base.publicFunctions -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_function.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("friends") -%} - {%- for child in friends -%} - {%- if child.type != "class" and child.type != "struct" -%} - {%- include "synopsis_friend_function.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endif -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "friends") -%} - {%- for child in base.friends -%} - {%- if child.type != "class" and child.type != "struct" -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_friend_function.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endif -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if default(has_public_members, false) -%} - {%- if default(has_protected_members, false) -%} -
- {%- endif -%} -{%- endif -%} -{#- Reset leading line breaks for protected members -#}{{ noop() -}} -{%- set synopsis_needs_leading_line_break = false -%} -{%- if default(has_protected_members, false) -%} - protected:{{- noop() -}} -{%- endif -%} -{%- if exists("protectedTypes") -%} - {%- for child in protectedTypes -%} - {%- include "synopsis_type.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "protectedTypes") -%} - {%- for child in base.protectedTypes -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_type.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("protectedClasses") -%} - {%- for child in protectedClasses -%} - {%- include "synopsis_class.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "protectedClasses") -%} - {%- for child in base.protectedClasses -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_class.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("protectedAttributes") -%} - {%- for child in protectedAttributes -%} - {%- include "synopsis_variable.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "protectedAttributes") -%} - {%- for child in base.protectedAttributes -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_variable.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- if exists("protectedFunctions") -%} - {%- for child in protectedFunctions -%} - {%- include "synopsis_function.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("baseClasses") -%}{%- for base in baseClasses -%} - {%- if existsIn(base, "protectedFunctions") -%} - {%- for child in base.protectedFunctions -%} - {%- set synopsis_is_inherited = true -%} - {%- include "synopsis_function.tmpl" -%} - {%- set synopsis_is_inherited = false -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} - {%- endif -%} -{%- endfor -%}{%- endif -%} -{%- set synopsis_indent_width = 0 -%} -}; - - diff --git a/docs/doxybook/templates/class_members_details.tmpl b/docs/doxybook/templates/class_members_details.tmpl deleted file mode 100644 index a77eec5ef..000000000 --- a/docs/doxybook/templates/class_members_details.tmpl +++ /dev/null @@ -1,49 +0,0 @@ -{%- if exists("publicClasses") -%}## Member Classes - - {%- for child in publicClasses -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("publicTypes") -%}## Member Types - - {%- for child in publicTypes -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("publicAttributes") %}## Member Variables - - {%- for child in publicAttributes -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("publicFunctions") %}## Member Functions - - {%- for child in publicFunctions -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("protectedTypes") -%}## Protected Member Types - {%- for child in publicTypes -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{% endif -%} -{%- if exists("protectedAttributes") -%}## Protected Member Variables - - {%- for child in protectedAttributes -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("protectedFunctions") -%}## Protected Member Functions - - {%- for child in protectedFunctions -%} - {% include "title_member.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} - diff --git a/docs/doxybook/templates/details.tmpl b/docs/doxybook/templates/details.tmpl deleted file mode 100644 index d72119abf..000000000 --- a/docs/doxybook/templates/details.tmpl +++ /dev/null @@ -1,206 +0,0 @@ -{%- if exists("brief") -%}{{brief}} - -{% endif -%} -{%- if exists("details") -%}{{details}} - -{% endif -%} -{%- if exists("inbody") -%}{{inbody}} - -{% endif -%} -{%- if exists("tests") -%}**Test**: - {%- if length(tests) == 1 -%}{{first(tests)}} - {%- else -%} - {%- for item in tests -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("note") -%}**Note**: - {%- if length(note) == 1 -%}{{first(note)}} - {%- else -%} - {%- for item in note -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("remark") -%}**Remark**: - {%- if length(remark) == 1 -%}{{first(remark)}} - {%- else -%} - {%- for item in remark -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("attention") -%}**Attention**: - {%- if length(attention) == 1 -%}{{first(attention)}} - {%- else -%} - {%- for item in attention -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("bugs") -%}**Bug**: - {%- if length(bugs) == 1 -%}{{first(bugs)}} - {%- else -%} - {%- for item in bugs -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("warning") -%}**Warning**: - {%- if length(warning) == 1 -%}{{first(warning)}} - {%- else -%} - {%- for item in warning -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("todos") -%}**TODO**: - {%- if length(todos) == 1 -%}{{first(todos)}} - {%- else -%} - {%- for item in todos -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("templateParamsList") -%}**Template Parameters**: - {%- if length(templateParamsList) == 1 -%}**`{{get(first(templateParamsList), "name")}}`**: {{get(first(templateParamsList), "text")}} - {%- else -%} - {%- for param in templateParamsList -%}* **`{{param.name}}`** {{param.text}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("paramList") -%}**Function Parameters**: - {%- if length(paramList) == 1 -%}**`{{get(first(paramList), "name")}}`**: {{get(first(paramList), "text")}} - {%- else -%} - {%- for param in paramList -%}* **`{{param.name}}`** {{param.text}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("pre") -%}**Preconditions**: - {%- if length(pre) == 1 -%}{{first(pre)}} - {%- else -%} - {%- for item in pre -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("post") -%}**Postconditions**: - {%- if length(post) == 1 -%}{{first(post)}} - {%- else -%} - {%- for item in post -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("invariant") -%}**Invariant**: - {%- if length(invariant) == 1 -%}{{first(invariant)}} - {%- else -%} - {%- for item in invariant -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("returns") or exists("returnsList") -%}**Returns**: - {%- if exists("returns") and exists("returnsList") -%} - {%- for item in returns -%}* {{item}} - {%- endfor -%} - {%- for item in returnsList -%}* **`{{item.name}}`**: {{item.text}} - {%- endfor -%} - {%- else if exists("returns") -%} - {%- if length(returns) == 1 -%}{{first(returns)}} - {%- else -%} - {%- for item in returns -%}* {{item}} - {%- endfor -%} - {%- endif -%} - {%- else if exists("returnsList") -%} - {%- if length(returnsList) == 1 -%}**`{{get(first(returnsList), "name")}}`** {{get(first(returnsList), "text")}} - {%- else -%} - {%- for item in returnsList -%}* **`{{item.name}}`**: {{item.text}} - {%- endfor -%} - {%- endif -%} - {%- endif %} -{% endif -%} -{%- if exists("exceptionsList") -%}**Exceptions**: - {%- if length(exceptionsList) == 1 -%}**`{{get(first(exceptionsList), "name")}}`**: {{get(first(exceptionsList), "text")}} - {%- else -%} - {%- for param in exceptionsList -%}* **`{{param.name}}`**: {{param.text}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("deprecated") -%}**Deprecated**: {{deprecated}} - -{% endif -%} -{%- if exists("authors") -%}**Author**: - {%- if length(authors) == 1 -%}{{first(authors)}} - {%- else -%} - {%- for item in authors -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("copyright") -%}**Copyright**: - {%- if length(copyright) == 1 -%}{{first(copyright)}} - {%- else -%} - {%- for item in copyright -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("version") -%}**Version**: - {%- if length(version) == 1 -%}{{first(version)}} - {%- else -%} - {%- for item in version -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("since") -%}**Since**: - {%- if length(since) == 1 -%}{{first(since)}} - {%- else -%} - {%- for item in since -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("date") -%}**Date**: - {%- if length(date) == 1 -%}{{first(date)}} - {%- else -%} - {%- for item in date -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("baseClasses") -%}**Inherits From**: - {%- if length(baseClasses) == 1 -%} - {%- if existsIn(first(baseClasses), "url") -%}[`{{get(first(baseClasses), "name")}}`]({{get(first(baseClasses), "url")}}) - {%- else -%}`{{get(first(baseClasses), "name")}}` - {%- endif -%} - {%- else -%} - {%- for base in baseClasses -%} - {%- if existsIn(baseClasses, "url") -%}* [`{{base.name}}`]({{base.url}}) - {%- else -%}* `{{base.name}}` - {%- endif -%} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("derivedClasses") -%}**Inherited By**: - {%- if length(derivedClasses) == 1 -%} - {%- if existsIn(first(derivedClasses), "url") -%}[`{{get(first(derivedClasses), "name")}}`]({{get(first(derivedClasses), "url")}}) - {%- else -%}`{{get(first(derivedClasses), "name")}}` - {%- endif -%} - {%- else -%} - {%- for derived in derivedClasses -%} - {%- if existsIn(first(derivedClasses), "url") -%}* [`{{derived.name}}`]({{derived.url}}) - {%- else -%}* `{{derived.name}}`{%- endif -%} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("reimplements") -%}**Implements**: [`{{reimplements.name}}`]({{reimplements.url}}) - -{% endif -%} -{%- if exists("reimplementedBy") -%}**Implemented By**: - {%- if length(reimplementedBy) == 1 -%} - {%- if existsIn(first(reimplementedBy), "url") -%}[`{{get(first(reimplementedBy), "name")}}`]({{get(first(reimplementedBy), "url")}}) - {%- else -%}`{{get(first(reimplementedBy), "name")}}` - {%- endif -%} - {%- else -%} - {%- for impl in reimplementedBy -%} - {%- if existsIn(first(reimplementedBy), "url") -%}* [`{{impl.name}}`]({{impl.url}}) - {%- else -%}* `{{impl.name}}` - {%- endif -%} - {%- endfor -%} - {%- endif %} -{% endif -%} -{%- if exists("see") -%}**See**: - {%- if length(see) == 1 -%}{{first(see)}} - {%- else -%} - {%- for item in see -%}* {{item}} - {%- endfor -%} - {%- endif %} -{% endif -%} diff --git a/docs/doxybook/templates/frontmatter.tmpl b/docs/doxybook/templates/frontmatter.tmpl deleted file mode 100644 index d3b1e5b4f..000000000 --- a/docs/doxybook/templates/frontmatter.tmpl +++ /dev/null @@ -1,43 +0,0 @@ ---- -{%- if exists("title") -%} - title: {{title}} -{%- else if exists("name") -%} - title: {{name}} -{%- endif -%} -{%- if exists("summary") -%} - summary: {{summary}} -{%- endif -%} -{%- if exists("moduleBreadcrumbs") -%} - {%- if length(moduleBreadcrumbs) > 0 -%} - parent: {{ get(last(moduleBreadcrumbs), "title") }} - {%- endif -%} - {%- if length(moduleBreadcrumbs) > 1 -%} - grand_parent: {{ get(index(moduleBreadcrumbs, -2), "title") }} - {%- else if length(moduleBreadcrumbs == 1) and exists("kind") and kind == "group" -%} - grand_parent: API - {%- endif -%} -{%- else if exists("kind") and kind == "group" -%} - parent: API -{%- endif -%} -{%- if exists("kind") and kind == "group" -%} - nav_exclude: false -{%- else -%} - nav_exclude: true -{%- endif -%} -has_children: true -has_toc: false ---- - -{%- if exists("title") -%} - {%- if exists("kind") and kind in ["class", "struct", "namespace"] -%} - # {{title(kind)}} `{{title}}` - {%- else -%} - # {{title}} - {%- endif -%} -{%- else if exists("name") -%} - {%- if exists("kind") and kind != "page" -%} - # {{name}} {{title(kind)}} Reference - {%- else -%} - # {{name}} - {%- endif -%} -{%- endif %} diff --git a/docs/doxybook/templates/index.tmpl b/docs/doxybook/templates/index.tmpl deleted file mode 100644 index e28f37729..000000000 --- a/docs/doxybook/templates/index.tmpl +++ /dev/null @@ -1,14 +0,0 @@ -{%- if exists("children") -%}{%- for child in children -%} - {%- for i in range(default(index_depth, 0)) -%} - {{- noop() }} {{ noop() -}} - {%- endfor -%} - * {{ noop() -}} - {{ render("name_qualified.tmpl", child) }}{{ noop() -}} - {%- if existsIn(child, "brief") -%} - {{- noop() }}
{{ child.brief -}} - {%- endif %} - {%- if existsIn(child, "children") -%} - {%- set child.index_depth = default(index_depth, 0) + 1 -%} - {{- render("index.tmpl", child) -}} - {%- endif -%} -{%- endfor -%}{%- endif -%} diff --git a/docs/doxybook/templates/index_classes.tmpl b/docs/doxybook/templates/index_classes.tmpl deleted file mode 100644 index 1ccdf71e9..000000000 --- a/docs/doxybook/templates/index_classes.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{% include "index.tmpl" -%} diff --git a/docs/doxybook/templates/index_examples.tmpl b/docs/doxybook/templates/index_examples.tmpl deleted file mode 100644 index 1ccdf71e9..000000000 --- a/docs/doxybook/templates/index_examples.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{% include "index.tmpl" -%} diff --git a/docs/doxybook/templates/index_files.tmpl b/docs/doxybook/templates/index_files.tmpl deleted file mode 100644 index 1ccdf71e9..000000000 --- a/docs/doxybook/templates/index_files.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{% include "index.tmpl" -%} diff --git a/docs/doxybook/templates/index_groups.tmpl b/docs/doxybook/templates/index_groups.tmpl deleted file mode 100644 index 1ccdf71e9..000000000 --- a/docs/doxybook/templates/index_groups.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{% include "index.tmpl" -%} diff --git a/docs/doxybook/templates/index_namespaces.tmpl b/docs/doxybook/templates/index_namespaces.tmpl deleted file mode 100644 index 1ccdf71e9..000000000 --- a/docs/doxybook/templates/index_namespaces.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{% include "index.tmpl" -%} diff --git a/docs/doxybook/templates/index_pages.tmpl b/docs/doxybook/templates/index_pages.tmpl deleted file mode 100644 index 1ccdf71e9..000000000 --- a/docs/doxybook/templates/index_pages.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{% include "index.tmpl" -%} diff --git a/docs/doxybook/templates/kind_class.tmpl b/docs/doxybook/templates/kind_class.tmpl deleted file mode 100644 index e5650b69b..000000000 --- a/docs/doxybook/templates/kind_class.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{%- if hasDetails -%}{% include "details.tmpl" -%}{%- endif -%} -{% include "class_members.tmpl" -%} -{% include "class_members_details.tmpl" -%} diff --git a/docs/doxybook/templates/kind_example.tmpl b/docs/doxybook/templates/kind_example.tmpl deleted file mode 100644 index 48501318b..000000000 --- a/docs/doxybook/templates/kind_example.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{%- if exists("details") -%}{{details}}{%- endif -%} diff --git a/docs/doxybook/templates/kind_file.tmpl b/docs/doxybook/templates/kind_file.tmpl deleted file mode 100644 index c883442f1..000000000 --- a/docs/doxybook/templates/kind_file.tmpl +++ /dev/null @@ -1,10 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{%- if hasDetails -%}{% include "details.tmpl" -%}{%- endif -%} -{% include "nonclass_members_details.tmpl" -%} -{% include "nonclass_members.tmpl" -%} -{%- if exists("programlisting") -%} - -```cpp -{{programlisting}} -``` -{%- endif -%} diff --git a/docs/doxybook/templates/kind_group.tmpl b/docs/doxybook/templates/kind_group.tmpl deleted file mode 100644 index 1ff7342a4..000000000 --- a/docs/doxybook/templates/kind_group.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{%- if hasDetails %}{% include "details.tmpl" -%}{%- endif -%} -{% include "nonclass_members.tmpl" -%} -{% include "nonclass_members_details.tmpl" -%} diff --git a/docs/doxybook/templates/kind_nonclass.tmpl b/docs/doxybook/templates/kind_nonclass.tmpl deleted file mode 100644 index 299208c41..000000000 --- a/docs/doxybook/templates/kind_nonclass.tmpl +++ /dev/null @@ -1,8 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{%- if hasDetails %}{% include "details.tmpl" -%}{%- endif -%} -{% if kind == "namespace" -%} - {%- include "namespace_members.tmpl" -%} -{%- else -%} - {%- include "nonclass_members.tmpl" -%} -{%- endif -%} -{% include "nonclass_members_details.tmpl" -%} diff --git a/docs/doxybook/templates/kind_page.tmpl b/docs/doxybook/templates/kind_page.tmpl deleted file mode 100644 index 48501318b..000000000 --- a/docs/doxybook/templates/kind_page.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -{% include "frontmatter.tmpl" -%} -{%- if exists("details") -%}{{details}}{%- endif -%} diff --git a/docs/doxybook/templates/member_details.tmpl b/docs/doxybook/templates/member_details.tmpl deleted file mode 100644 index 14b34dcfc..000000000 --- a/docs/doxybook/templates/member_details.tmpl +++ /dev/null @@ -1,39 +0,0 @@ -{%- if exists("type") and type in ["class", "struct"] -%} - - {%- include "synopsis_class.tmpl" -%} - -{%- else if kind == "enum" -%} - {%- include "table_header_enum.tmpl" -%} - {%- for enumerator in enumvalues -%}{{- render("table_row_enum.tmpl", enumerator) -}} - {%- endfor %} -{%- else if kind in ["typedef", "using"] -%} - - {%- include "synopsis_template_parameters.tmpl" -%} - {%- include "synopsis_kind.tmpl" -%}{{name}}{%- include "synopsis_initializer.tmpl" -%};{{- noop() -}} - -{%- else if kind in ["variable", "property"] -%} - - {%- include "synopsis_template_parameters.tmpl" -%} - {%- include "synopsis_type_and_leading_specifiers.tmpl" -%}{{name}}{%- include "synopsis_initializer.tmpl" -%};{{- noop() -}} - -{%- else if kind in ["function", "slot", "signal", "event"] -%} - - {%- include "synopsis_template_parameters.tmpl" -%} - {% include "synopsis_function_type_and_leading_specifiers.tmpl" -%} - {{name}}({%- include "synopsis_function_parameters.tmpl" -%}){%- include "synopsis_function_trailing_specifiers.tmpl" -%};{{- noop() -}} - -{%- else if kind == "friend" -%} - {%- if type != "class" and type != "struct" -%} - - {% include "synopsis_template_parameters.tmpl" -%} - {% include "synopsis_function_type_and_leading_specifiers.tmpl" -%} - {{name}}({%- include "synopsis_function_parameters.tmpl" -%}){%- include "synopsis_function_trailing_specifiers.tmpl" -%};{{- noop() -}} - - {%- endif -%} -{%- else if kind == "define" -%} - {#- We have no way to get the parameters to function-like -#}{{ noop() -}} - {#- macros, and the macro definitions in `initializer` fields -#}{{ noop() -}} - {#- don't have line breaks. So we can't render a useful -#}{{ noop() -}} - {#- synopsis. -#}{{ noop() -}} -{% endif -%} -{% include "details.tmpl" -%} diff --git a/docs/doxybook/templates/name.tmpl b/docs/doxybook/templates/name.tmpl deleted file mode 100644 index 09f15420e..000000000 --- a/docs/doxybook/templates/name.tmpl +++ /dev/null @@ -1,5 +0,0 @@ -{%- if default(names_qualified, true) -%} - {{- render("name_qualified.tmpl", child) -}} -{%- else -%} - {{- render("name_unqualified.tmpl", child) -}} -{%- endif -%} diff --git a/docs/doxybook/templates/name_qualified.tmpl b/docs/doxybook/templates/name_qualified.tmpl deleted file mode 100644 index da088dd34..000000000 --- a/docs/doxybook/templates/name_qualified.tmpl +++ /dev/null @@ -1,7 +0,0 @@ -{%- if exists("qualifiedname") -%} - {{- escape(qualifiedname) -}} -{%- else if exists("name") -%} - {{- escape(name) -}} -{%- else -%} - {{- escape(title) -}} -{%- endif -%} diff --git a/docs/doxybook/templates/name_unqualified.tmpl b/docs/doxybook/templates/name_unqualified.tmpl deleted file mode 100644 index 2a0d73725..000000000 --- a/docs/doxybook/templates/name_unqualified.tmpl +++ /dev/null @@ -1,5 +0,0 @@ -{%- if exists("name") -%} - {{- escape(stripNamespace(name)) -}} -{%- else -%} - {{- escape(stripNamespace(title)) -}} -{%- endif -%} diff --git a/docs/doxybook/templates/namespace_members.tmpl b/docs/doxybook/templates/namespace_members.tmpl deleted file mode 100644 index 8bb4bdffc..000000000 --- a/docs/doxybook/templates/namespace_members.tmpl +++ /dev/null @@ -1,43 +0,0 @@ - -{%- if exists("includes") -%} - #include {{includes}}{{ noop() -}} -
-{%- endif -%} -{%- include "synopsis_kind.tmpl" -%}{% include "name_qualified.tmpl" %} { -{%- set synopsis_needs_leading_line_break = true -%} -{%- set names_qualified = false -%} -{%- if exists("namespaces") -%} - {%- for child in namespaces -%} - {%- include "synopsis_namespace_abbreviated.tmpl" -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicClasses") -%} - {%- for child in publicClasses -%} - {%- include "synopsis_class.tmpl" -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicTypes") -%} - {%- for child in publicTypes -%} - {%- include "synopsis_type.tmpl" -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicAttributes") -%} - {%- for child in publicAttributes -%} - {%- include "synopsis_variable.tmpl" -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicFunctions") -%} - {%- for child in publicFunctions -%} - {%- if existsIn(child, "type") -%} - {#- If the child doesn't have a type, it's probably a -#}{{- noop() -}} - {#- constructor that Doxygen put into a non-class entity -#}{{- noop() -}} - {#- due to a bug whose nature is beyond me. -#}{{- noop() -}} - {%- include "synopsis_function.tmpl" -%} - {%- endif -%} - {%- endfor -%} -{%- endif -%} -} {{ noop() -}} - /* {%- include "synopsis_kind.tmpl" -%}{% include "name_qualified.tmpl" %} */{{ noop() -}} - - - diff --git a/docs/doxybook/templates/nonclass_members.tmpl b/docs/doxybook/templates/nonclass_members.tmpl deleted file mode 100644 index af3d39c17..000000000 --- a/docs/doxybook/templates/nonclass_members.tmpl +++ /dev/null @@ -1,60 +0,0 @@ -{%- if exists("groups") %}## Groups - - {%- for child in sort(groups) -%}* **[{{ child.title }}]({{ child.url }})**{% if existsIn(child, "brief") %}: {{ child.brief }}{% endif %} - {%- endfor %} -{% endif -%} -{%- if exists("dirs") %}## Directories - - {%- for child in dirs -%}* **[`{{ child.name }}`]({{ child.url }})**{% if existsIn(child, "brief") %}: {{ child.brief }}{% endif %} - {%- endfor %} -{% endif -%} -{%- if exists("files") %}## Files - - {%- include "table_header_brief.tmpl" -%} - {%- for child in files -%}{{- render("table_row_brief.tmpl", child) -}} - {%- endfor %} -{% endif -%} - -{%- if exists("namespaces") -%} - {%- for child in namespaces -%} - {%- include "synopsis_namespace_abbreviated.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicClasses") -%} - {%- for child in publicClasses -%} - {%- include "synopsis_class.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicTypes") -%} - {%- for child in publicTypes -%} - {%- include "synopsis_type.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicAttributes") -%} - {%- for child in publicAttributes -%} - {%- include "synopsis_variable.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("publicFunctions") -%} - {%- for child in publicFunctions -%} - {%- if existsIn(child, "type") -%} - {#- If the child doesn't have a type, it's probably a -#}{{- noop() -}} - {#- constructor that Doxygen put into a non-class entity -#}{{- noop() -}} - {#- due to a bug whose nature is beyond me. -#}{{- noop() -}} - {%- include "synopsis_function.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endif -%} - {%- endfor -%} -{%- endif -%} -{%- if exists("defines") -%} - {%- for child in defines -%} - {%- include "synopsis_macro.tmpl" -%} - {%- set synopsis_needs_leading_line_break = true -%} - {%- endfor -%} -{%- endif -%} - - diff --git a/docs/doxybook/templates/nonclass_members_details.tmpl b/docs/doxybook/templates/nonclass_members_details.tmpl deleted file mode 100644 index c941f22f7..000000000 --- a/docs/doxybook/templates/nonclass_members_details.tmpl +++ /dev/null @@ -1,35 +0,0 @@ -{%- if exists("publicClasses") -%}## Member Classes - - {%- for child in publicClasses -%} - {% include "title_nonmember.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("publicTypes") -%}## Types - - {%- for child in publicTypes -%} - {% include "title_nonmember.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("publicAttributes") %}## Variables - - {%- for child in publicAttributes -%} - {% include "title_nonmember.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("publicFunctions") %}## Functions - - {%- for child in publicFunctions -%} - {% include "title_nonmember.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} -{%- if exists("defines") %}## Macros - - {%- for child in defines -%} - {% include "title_nonmember.tmpl" %} - {{- render("member_details.tmpl", child) -}} - {%- endfor %} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_brief.tmpl b/docs/doxybook/templates/synopsis_brief.tmpl deleted file mode 100644 index 2f48cec1d..000000000 --- a/docs/doxybook/templates/synopsis_brief.tmpl +++ /dev/null @@ -1,8 +0,0 @@ -{%- if exists("brief") -%} - {{ noop() -}} - {%- if default(synopsis_indent_width, 0) != 0 -%} - {%- include "synopsis_indent.tmpl" -%} - {%- endif -%} - /* {{ brief }} */{{ noop() -}} - {{ noop() -}} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_class.tmpl b/docs/doxybook/templates/synopsis_class.tmpl deleted file mode 100644 index a5492997c..000000000 --- a/docs/doxybook/templates/synopsis_class.tmpl +++ /dev/null @@ -1,16 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- include "synopsis_inherited_from.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{#- The Doxygen metadata that a parent has on its nested -#}{{ noop() -}} -{#- classes doesn't include their template parameters. -#}{{ noop() -}} -{#- Fortunately, we have the refid of the nested class, so -#}{{ noop() -}} -{#- so we can just load the data from their page. -#}{{ noop() -}} -{%- set child_class = load(child.refid)) -%} -{%- set child_class.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_template_parameters.tmpl", child_class) -}} -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {{- render("synopsis_kind_abbreviated.tmpl", child) -}} - {% include "name.tmpl" %};{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_friend_class.tmpl b/docs/doxybook/templates/synopsis_friend_class.tmpl deleted file mode 100644 index 39f23bb09..000000000 --- a/docs/doxybook/templates/synopsis_friend_class.tmpl +++ /dev/null @@ -1,14 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- include "synopsis_inherited_from.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{- render("synopsis_template_parameters.tmpl", child) -}} -{#- Unfortunately, the refid and URL for a friend class -#}{{ noop() -}} -{#- incorrectly refers to a definition on the local -#}{{ noop() -}} -{#- page, instead of the friend class's own page. -#}{{ noop() -}} -{#- So we don't link to friend classes. -#}{{ noop() -}} -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {{- render("synopsis_kind_abbreviated.tmpl", child) -}} - {{- render("name_qualified.tmpl", child) -}};{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_friend_function.tmpl b/docs/doxybook/templates/synopsis_friend_function.tmpl deleted file mode 100644 index 440989c23..000000000 --- a/docs/doxybook/templates/synopsis_friend_function.tmpl +++ /dev/null @@ -1,19 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- include "synopsis_inherited_from.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{- render("synopsis_template_parameters.tmpl", child) -}} -{#- Unfortunately, the refid and URL for a friend class -#}{{ noop() -}} -{#- incorrectly refers to a definition on the local -#}{{ noop() -}} -{#- page, instead of the friend class's own page. -#}{{ noop() -}} -{#- So we don't link to friend classes. -#}{{ noop() -}} -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - friend {{- render("synopsis_type_and_leading_specifiers.tmpl", child) -}} - -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {{- render("name_qualified.tmpl", child) -}}{{ noop() -}} - ({{- render("synopsis_function_parameters.tmpl", child) -}}){{ noop() -}} - {{- render("synopsis_function_trailing_specifiers.tmpl", child) -}};{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_function.tmpl b/docs/doxybook/templates/synopsis_function.tmpl deleted file mode 100644 index 93a3e822e..000000000 --- a/docs/doxybook/templates/synopsis_function.tmpl +++ /dev/null @@ -1,12 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- include "synopsis_inherited_from.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{- render("synopsis_template_parameters.tmpl", child) -}} -{{- render("synopsis_function_type_and_leading_specifiers.tmpl", child) -}} -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {% include "name.tmpl" %}{{ noop() -}} - ({{- render("synopsis_function_parameters.tmpl", child) -}}){{ noop() -}} - {{- render("synopsis_function_trailing_specifiers.tmpl", child) -}};{{- noop() -}} - diff --git a/docs/doxybook/templates/synopsis_function_parameters.tmpl b/docs/doxybook/templates/synopsis_function_parameters.tmpl deleted file mode 100644 index 204a52c50..000000000 --- a/docs/doxybook/templates/synopsis_function_parameters.tmpl +++ /dev/null @@ -1,11 +0,0 @@ -{%- for param in params -%} - {%- if not loop.is_first -%}  {%- endif -%} - {{- param.type -}} - {%- if not isEmpty(param.name) %} {% endif -%} - {{- param.name -}} - {%- if existsIn(param, "defvalPlain") %} = {{ escape(param.defvalPlain) }}{% endif -%} - {%- if not loop.is_last -%} - , - {{- noop() }}{% include "synopsis_indent.tmpl" -%} - {%- endif -%} -{%- endfor -%} diff --git a/docs/doxybook/templates/synopsis_function_trailing_specifiers.tmpl b/docs/doxybook/templates/synopsis_function_trailing_specifiers.tmpl deleted file mode 100644 index bbde0f1dd..000000000 --- a/docs/doxybook/templates/synopsis_function_trailing_specifiers.tmpl +++ /dev/null @@ -1,5 +0,0 @@ -{%- if const %} const{% endif -%} -{%- if override %} override{% endif -%} -{%- if default %} = default{% endif -%} -{%- if deleted %} = deleted{% endif -%} -{%- if pureVirtual %} = 0{% endif -%} diff --git a/docs/doxybook/templates/synopsis_function_type_and_leading_specifiers.tmpl b/docs/doxybook/templates/synopsis_function_type_and_leading_specifiers.tmpl deleted file mode 100644 index 5cde64d28..000000000 --- a/docs/doxybook/templates/synopsis_function_type_and_leading_specifiers.tmpl +++ /dev/null @@ -1,6 +0,0 @@ -{%- if default(virtual, false) or default(static, false) or default(explicit, false) or default(type, false) -%} - {{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {%- include "synopsis_type_and_leading_specifiers.tmpl" -%} - {{ noop() -}} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_indent.tmpl b/docs/doxybook/templates/synopsis_indent.tmpl deleted file mode 100644 index a2d7193a6..000000000 --- a/docs/doxybook/templates/synopsis_indent.tmpl +++ /dev/null @@ -1,5 +0,0 @@ -{%- if default(synopsis_indent_width, false) -%} - {%- for i in range(synopsis_indent_width) -%} -  {{ noop() -}} - {%- endfor -%} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_inherited_from.tmpl b/docs/doxybook/templates/synopsis_inherited_from.tmpl deleted file mode 100644 index fd88b649c..000000000 --- a/docs/doxybook/templates/synopsis_inherited_from.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{%- if default(synopsis_is_inherited, false) != false -%} - {%- set base.synopsis_indent_width = default(synopsis_indent_width, 0) -%} - {{- render("synopsis_inherited_from_comment.tmpl", base) -}} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_inherited_from_comment.tmpl b/docs/doxybook/templates/synopsis_inherited_from_comment.tmpl deleted file mode 100644 index 4afda1250..000000000 --- a/docs/doxybook/templates/synopsis_inherited_from_comment.tmpl +++ /dev/null @@ -1,8 +0,0 @@ -{{ noop() -}} - {%- if default(synopsis_indent_width, 0) != 0 -%} - {%- include "synopsis_indent.tmpl" -%} - {%- endif -%} - /* Inherited from {{ noop() -}} - {%- include "name_qualified.tmpl" -%}{{ noop() -}} - */{{ noop() -}} -{{ noop() -}} diff --git a/docs/doxybook/templates/synopsis_initializer.tmpl b/docs/doxybook/templates/synopsis_initializer.tmpl deleted file mode 100644 index dd159979d..000000000 --- a/docs/doxybook/templates/synopsis_initializer.tmpl +++ /dev/null @@ -1,3 +0,0 @@ -{%- if kind == "using" %} = {{ escape(type) -}} -{%- else if exists("initializer") %} {{ escape(initializer) -}} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_initializer_abbreviated.tmpl b/docs/doxybook/templates/synopsis_initializer_abbreviated.tmpl deleted file mode 100644 index 2bc4d4856..000000000 --- a/docs/doxybook/templates/synopsis_initializer_abbreviated.tmpl +++ /dev/null @@ -1 +0,0 @@ -{% if kind == "using" or exists("initializer") %} = see below{% endif -%} diff --git a/docs/doxybook/templates/synopsis_kind.tmpl b/docs/doxybook/templates/synopsis_kind.tmpl deleted file mode 100644 index 34cd602a9..000000000 --- a/docs/doxybook/templates/synopsis_kind.tmpl +++ /dev/null @@ -1,9 +0,0 @@ -{%- if kind == "interface" %}class {{ noop() -}} -{%- else if kind == "namespace" %}namespace {{ noop() -}} -{%- else if kind == "typedef" %}typedef {{ type -}} -{%- else if kind == "enum" %}enum {% if strong %}class {% endif -%} {{ noop() -}} -{%- else if kind == "friend" %}friend {{ noop() -}} - {%- if type == "class" or type == "struct" %}{{ type }} {% endif -%} -{%- else if kind == "define" %}#define {{ noop() -}} -{%- else %}{{ kind }} {{ noop() -}} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_kind_abbreviated.tmpl b/docs/doxybook/templates/synopsis_kind_abbreviated.tmpl deleted file mode 100644 index 881582773..000000000 --- a/docs/doxybook/templates/synopsis_kind_abbreviated.tmpl +++ /dev/null @@ -1,9 +0,0 @@ -{%- if kind == "interface" %}class {{ noop() -}} -{%- else if kind == "namespace" %}namespace {{ noop() -}} -{%- else if kind == "typedef" %}typedef see below {{ noop() -}} -{%- else if kind == "enum" %}enum {% if strong %}class {% endif -%} -{%- else if kind == "friend" %}friend {{ noop() -}} - {%- if type == "class" or type == "struct" %}{{type}} {% endif -%} -{%- else if kind == "define" %}#define {{ noop() -}} -{%- else %}{{ kind }} {{ noop() -}} -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_leading_line_break.tmpl b/docs/doxybook/templates/synopsis_leading_line_break.tmpl deleted file mode 100644 index 13a1574e3..000000000 --- a/docs/doxybook/templates/synopsis_leading_line_break.tmpl +++ /dev/null @@ -1,3 +0,0 @@ -{%- if default(synopsis_needs_leading_line_break, false) -%} -
-{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_macro.tmpl b/docs/doxybook/templates/synopsis_macro.tmpl deleted file mode 100644 index 612773439..000000000 --- a/docs/doxybook/templates/synopsis_macro.tmpl +++ /dev/null @@ -1,7 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{ noop() -}} - {{- render("synopsis_kind.tmpl", child) -}} - {{- render("name_qualified.tmpl", child) -}}{{ noop() -}} - {{- render("synopsis_initializer_abbreviated.tmpl", child) -}};{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_member_namespace_abbreviated.tmpl b/docs/doxybook/templates/synopsis_member_namespace_abbreviated.tmpl deleted file mode 100644 index 682f615c9..000000000 --- a/docs/doxybook/templates/synopsis_member_namespace_abbreviated.tmpl +++ /dev/null @@ -1,7 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{ noop() -}} - {{- render("synopsis_kind_abbreviated.tmpl", child) -}} - {{- render("name_qualified.tmpl", child) -}} { … }{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_namespace_abbreviated.tmpl b/docs/doxybook/templates/synopsis_namespace_abbreviated.tmpl deleted file mode 100644 index 682f615c9..000000000 --- a/docs/doxybook/templates/synopsis_namespace_abbreviated.tmpl +++ /dev/null @@ -1,7 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{ noop() -}} - {{- render("synopsis_kind_abbreviated.tmpl", child) -}} - {{- render("name_qualified.tmpl", child) -}} { … }{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_template_parameters.tmpl b/docs/doxybook/templates/synopsis_template_parameters.tmpl deleted file mode 100644 index 4391c3d99..000000000 --- a/docs/doxybook/templates/synopsis_template_parameters.tmpl +++ /dev/null @@ -1,14 +0,0 @@ -{%- if exists("templateParams") -%} - {% include "synopsis_indent.tmpl" -%}template <{{ noop() -}} - {%- for param in templateParams -%} - {%- if not loop.is_first %}{% include "synopsis_indent.tmpl" -%}  {% endif -%} - {{- param.type -}} - {%- if not isEmpty(param.name) %} {% endif -%} - {{- param.name -}} - {%- if existsIn(param, "defvalPlain") %} = {{ escape(param.defvalPlain) }}{% endif -%} - {%- if not loop.is_last -%} - , - {{- noop() }}{% include "synopsis_indent.tmpl" -%} - {%- endif -%} - {%- endfor -%}> -{%- endif -%} diff --git a/docs/doxybook/templates/synopsis_type.tmpl b/docs/doxybook/templates/synopsis_type.tmpl deleted file mode 100644 index 586555f08..000000000 --- a/docs/doxybook/templates/synopsis_type.tmpl +++ /dev/null @@ -1,11 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- include "synopsis_inherited_from.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{- render("synopsis_template_parameters.tmpl", child) -}} -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {{- render("synopsis_kind_abbreviated.tmpl", child) -}} - {% include "name.tmpl" %}{{ noop() -}} - {{- render("synopsis_initializer_abbreviated.tmpl", child) -}};{{ noop() -}} - diff --git a/docs/doxybook/templates/synopsis_type_and_leading_specifiers.tmpl b/docs/doxybook/templates/synopsis_type_and_leading_specifiers.tmpl deleted file mode 100644 index 12136020f..000000000 --- a/docs/doxybook/templates/synopsis_type_and_leading_specifiers.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{%- if default(virtual, false) %}virtual {% endif -%} -{%- if default(static, false) %}static {% endif -%} -{%- if default(explicit, false) %}explicit {% endif -%} -{%- if exists("type") %}{{ type }} {% endif -%} diff --git a/docs/doxybook/templates/synopsis_variable.tmpl b/docs/doxybook/templates/synopsis_variable.tmpl deleted file mode 100644 index 52c48da50..000000000 --- a/docs/doxybook/templates/synopsis_variable.tmpl +++ /dev/null @@ -1,11 +0,0 @@ -{%- include "synopsis_leading_line_break.tmpl" -%} -{%- include "synopsis_inherited_from.tmpl" -%} -{%- set child.synopsis_indent_width = default(synopsis_indent_width, 0) -%} -{{- render("synopsis_brief.tmpl", child) -}} -{{- render("synopsis_template_parameters.tmpl", child) -}} -{{ noop() -}} - {%- include "synopsis_indent.tmpl" -%} - {{- render("synopsis_type_and_leading_specifiers.tmpl", child) -}} - {% include "name.tmpl" %}{{ noop() -}} - {{- render("synopsis_initializer_abbreviated.tmpl", child) -}};{{ noop() -}} - diff --git a/docs/doxybook/templates/table_header_brief.tmpl b/docs/doxybook/templates/table_header_brief.tmpl deleted file mode 100644 index ed13f970f..000000000 --- a/docs/doxybook/templates/table_header_brief.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -| Name | Description | -|------|-------------| diff --git a/docs/doxybook/templates/table_header_enum.tmpl b/docs/doxybook/templates/table_header_enum.tmpl deleted file mode 100644 index cdf95bc6f..000000000 --- a/docs/doxybook/templates/table_header_enum.tmpl +++ /dev/null @@ -1,2 +0,0 @@ -| Enumerator | Value | Description | -|------------|-------|-------------| diff --git a/docs/doxybook/templates/table_row_brief.tmpl b/docs/doxybook/templates/table_row_brief.tmpl deleted file mode 100644 index 1d599755f..000000000 --- a/docs/doxybook/templates/table_row_brief.tmpl +++ /dev/null @@ -1 +0,0 @@ -| **[`{{name}}`]({{url}})** | {% if exists("brief") %}{{brief}}{% endif %} | diff --git a/docs/doxybook/templates/table_row_enum.tmpl b/docs/doxybook/templates/table_row_enum.tmpl deleted file mode 100644 index 77c205be3..000000000 --- a/docs/doxybook/templates/table_row_enum.tmpl +++ /dev/null @@ -1 +0,0 @@ -| `{{ name }}` | {% if exists("initializer") -%}`{{ escape(replace(initializer, "= ", "")) }}`{%- endif %} | {% if exists("brief") -%}{{ brief }}{%- endif %} | diff --git a/docs/doxybook/templates/title_kind.tmpl b/docs/doxybook/templates/title_kind.tmpl deleted file mode 100644 index 100db2e84..000000000 --- a/docs/doxybook/templates/title_kind.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{%- if child.kind == "using" %}Type Alias{{ noop() -}} -{%- else -%}{{ title(child.kind) -}} -{%- endif -%} -{%- if child.kind == "enum" and child.strong %} Class{%- endif -%} diff --git a/docs/doxybook/templates/title_leading.tmpl b/docs/doxybook/templates/title_leading.tmpl deleted file mode 100644 index 54eb7e967..000000000 --- a/docs/doxybook/templates/title_leading.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -

-{%- if existsIn(child, "kind") and child.kind in ["class", "struct"] -%} - {{ noop() -}} -{%- endif -%} diff --git a/docs/doxybook/templates/title_member.tmpl b/docs/doxybook/templates/title_member.tmpl deleted file mode 100644 index 50e70f378..000000000 --- a/docs/doxybook/templates/title_member.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{%- include "title_leading.tmpl" -%} - {%- include "title_kind.tmpl" -%} - {{- noop() }} {% include "name_qualified.tmpl" %}::{{ render("name_unqualified.tmpl", child) }} -{%- include "title_trailing.tmpl" -%} diff --git a/docs/doxybook/templates/title_nonmember.tmpl b/docs/doxybook/templates/title_nonmember.tmpl deleted file mode 100644 index 4ea9797fd..000000000 --- a/docs/doxybook/templates/title_nonmember.tmpl +++ /dev/null @@ -1,5 +0,0 @@ -{%- include "title_leading.tmpl" -%} - {%- include "title_kind.tmpl" -%} - {{- noop() }} {{render("name_qualified.tmpl", child)}} -{%- include "title_trailing.tmpl" -%} - diff --git a/docs/doxybook/templates/title_trailing.tmpl b/docs/doxybook/templates/title_trailing.tmpl deleted file mode 100644 index fcc4f24e6..000000000 --- a/docs/doxybook/templates/title_trailing.tmpl +++ /dev/null @@ -1,4 +0,0 @@ -{%- if existsIn(child, "kind") and child.kind in ["class", "struct"] -%} - -{%- endif -%} -

diff --git a/docs/doxygen/config.dox b/docs/doxygen/config.dox deleted file mode 100644 index 7e06e3545..000000000 --- a/docs/doxygen/config.dox +++ /dev/null @@ -1,2611 +0,0 @@ -# Doxyfile 1.9.3 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = Thrust - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = . - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = YES - -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:^^" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". Note that you cannot put \n's in the value part of an alias -# to insert newlines (in the resulting output). You can put ^^ in the value part -# of an alias to insert a newline as if a physical newline was in the original -# file. When you need a literal { or } or , in the value part of an alias you -# have to escape them by means of a backslash (\), this can lead to conflicts -# with the commands \{ and \} for these it is advised to use the version @{ and -# @} or use a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, -# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files -# as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add -# * to the FILE_PATTERNS. -# -# Note see also the list of default file extension mappings. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 0 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = NO - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which effectively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = YES - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = YES - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class -# will show which file needs to be included to use the class. -# The default value is: YES. - -SHOW_HEADERFILE = YES - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = NO - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = YES - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = NO - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = NO - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. See also section "Changing the -# layout of pages" for information. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as documenting some parameters in -# a documented function twice, or documenting parameters that don't exist or -# using markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete -# function parameter documentation. If set to NO, doxygen will accept that some -# parameters have no documentation without warning. -# The default value is: YES. - -WARN_IF_INCOMPLETE_DOC = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong parameter -# documentation, but not about the absence of documentation. If EXTRACT_ALL is -# set to YES then this flag will automatically be disabled. See also -# WARN_IF_INCOMPLETE_DOC -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). In case the file specified cannot be opened for writing the -# warning and error messages are written to standard error. When as file - is -# specified the warning and error messages are written to standard output -# (stdout). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = thrust - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, -# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C -# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, -# *.vhdl, *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = *detail* - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# ANamespace::AClass, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = examples - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = YES - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = NO - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = build_docs/doxygen/html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a color-wheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use gray-scales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via JavaScript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have JavaScript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML -# output directory. Running make will produce the docset in that directory and -# running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag determines the URL of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDURL = - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: -# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo -# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the main .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = YES - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine tune the look of the index (see "Fine-tuning the output"). As an -# example, the default style sheet generated by doxygen has an example that -# shows how to put an image at the root of the tree instead of the PROJECT_NAME. -# Since the tree basically has the same information as the tab index, you could -# consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the -# FULL_SIDEBAR option determines if the side bar is limited to only the treeview -# area (value NO) or if it should extend to the full height of the window (value -# YES). Setting this to YES gives a layout similar to -# https://docs.readthedocs.io with more room for contents, but less room for the -# project logo, title, and description. If either GENERATE_TREEVIEW or -# DISABLE_INDEX is set to NO, this option has no effect. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FULL_SIDEBAR = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see -# https://inkscape.org) to generate formulas as SVG images instead of PNGs for -# the HTML output. These images will generally look nicer at scaled resolutions. -# Possible values are: png (the default) and svg (looks nicer but requires the -# pdf2svg or inkscape tool). -# The default value is: png. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FORMULA_FORMAT = png - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands -# to create new LaTeX commands to be used in formulas as building blocks. See -# the section "Including formulas" for details. - -FORMULA_MACROFILE = - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side JavaScript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. -# Note that the different versions of MathJax have different requirements with -# regards to the different settings, so it is possible that also other MathJax -# settings have to be changed when switching between the different MathJax -# versions. -# Possible values are: MathJax_2 and MathJax_3. -# The default value is: MathJax_2. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_VERSION = MathJax_2 - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. For more details about the output format see MathJax -# version 2 (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 -# (see: -# http://docs.mathjax.org/en/latest/web/components/output.html). -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility. This is the name for Mathjax version 2, for MathJax version 3 -# this will be translated into chtml), NativeMML (i.e. MathML. Only supported -# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This -# is the name for Mathjax version 3, for MathJax version 2 this will be -# translated into HTML-CSS) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. The default value is: -# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 -# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html -# #tex-and-latex-extensions): -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# For example for MathJax version 3 (see -# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): -# MATHJAX_EXTENSIONS = ams -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /