# Doxyfile 1.12.0

# 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 (\" \").

#

# Note:

#

# Use Doxygen to compare the used configuration file with the template

# configuration file:

# doxygen -x [configFile]

# Use Doxygen to compare the used configuration file with the template

# configuration file without replacing the environment variables or CMake type

# replacement variables:

# doxygen -x_noenv [configFile]

#---------------------------------------------------------------------------

# 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 = "Demeter"

# 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 = Demeter is a modern deterministic neutron

transport solver for reactor simulations.

# 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 =

# With the PROJECT_ICON tag one can specify an icon that is included in the tabs

# when the HTML document is shown. Doxygen will copy the logo to the output

# directory.

PROJECT_ICON =

# 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 = ./docs

# If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 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. Adapt CREATE_SUBDIRS_LEVEL to

# control the number of sub-directories.

# The default value is: NO.

CREATE_SUBDIRS = NO

# Controls the number of sub-directories that will be created when

# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every

# level increment doubles the number of directories, resulting in 4096

# directories at level 8 which is the default and also the maximum value. The

# sub-directories are organized in 2 levels, the first level always has a fixed

# number of 16 directories.

# Minimum value: 0, maximum value: 8, default value: 8.

# This tag requires that the tag CREATE_SUBDIRS is set to YES.

CREATE_SUBDIRS_LEVEL = 8

# 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, Bulgarian,

# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English

# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,

# Hindi, 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 = NO

# 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 = 4

# 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: 6.

# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

TOC_INCLUDE_HEADINGS = 6

# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to

# generate identifiers for the Markdown headings. Note: Every identifier is

# unique.

# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a

# sequence number starting at 0 and GITHUB use the lower case version of title

# with any whitespace replaced by '-' and punctuation characters removed.

# The default value is: DOXYGEN.

# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

MARKDOWN_ID_STYLE = DOXYGEN

# 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 makes 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) 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 of 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

# If the TIMESTAMP tag is set different from NO then each generated page will

# contain the date or date and time when the page was generated. Setting this to

# NO can help when comparing the output of multiple runs.

# Possible values are: YES, NO, DATETIME and DATE.

# The default value is: NO.

TIMESTAMP = NO

#---------------------------------------------------------------------------

# 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 = YES

# 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 = NO

# 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

# will also hide undocumented C++ concepts if enabled. This option has no effect

# if EXTRACT_ALL is enabled.

# The default value is: NO.

HIDE_UNDOC_CLASSES = NO

# 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 = NO

# 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 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.

# Possible values are: SYSTEM, NO and YES.

# The default value is: SYSTEM.

CASE_SENSE_NAMES = SYSTEM

# 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 = YES

# 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 = NO

# 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 <section_label> ... \endif and \cond <section_label>

# ... \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 = YES

# 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 = YES

# 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 = YES

# 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 =

# The EXTERNAL_TOOL_PATH tag can be used to extend the search path (PATH

# environment variable) so that external tools such as latex and gs can be

# found.

# Note: Directories specified with EXTERNAL_TOOL_PATH are added in front of the

# path already specified by the PATH variable, and are added in the order

# specified.

# Note: This option is particularly useful for macOS version 14 (Sonoma) and

# higher, when running Doxygen from Doxywizard, because in this case any user-

# defined changes to the PATH are ignored. A typical example on macOS is to set

# EXTERNAL_TOOL_PATH = /Library/TeX/texbin /usr/local/bin

# together with the standard path, the full search path used by doxygen when

# launching external tools will then become

# PATH=/Library/TeX/texbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin

EXTERNAL_TOOL_PATH =

#---------------------------------------------------------------------------

# 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 WARN_IF_UNDOC_ENUM_VAL option is set to YES, Doxygen will warn about

# undocumented enumeration values. If set to NO, Doxygen will accept

# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag

# will automatically be disabled.

# The default value is: NO.

WARN_IF_UNDOC_ENUM_VAL = 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.

# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then Doxygen behaves

# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined Doxygen will not

# write the warning messages in between other messages but write them at the end

# of a run, in case a WARN_LOGFILE is defined the warning messages will be

# besides being in the defined file also be shown at the end of a run, unless

# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case

# the behavior will remain as with the setting FAIL_ON_WARNINGS.

# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.

# 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)

# See also: WARN_LINE_FORMAT

# The default value is: $file:$line: $text.

WARN_FORMAT = "$file:$line: $text"

# In the $text part of the WARN_FORMAT command it is possible that a reference

# to a more specific place is given. To make it easier to jump to this place

# (outside of Doxygen) the user can define a custom "cut" / "paste" string.

# Example:

# WARN_LINE_FORMAT = "'vi $file +$line'"

# See also: WARN_FORMAT

# The default value is: at line $line of file $file.

WARN_LINE_FORMAT = "at line $line of file $file"

# 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 = ./src ./src/demeter/solve/linear_solver.hpp

# 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.

# See also: INPUT_FILE_ENCODING

# The default value is: UTF-8.

INPUT_ENCODING = UTF-8

# This tag can be used to specify the character encoding of the source files

# that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify

# character encoding on a per file pattern basis. Doxygen will compare the file

# name with each pattern and apply the encoding instead of the default

# INPUT_ENCODING) if there is a match. The character encodings are a list of the

# form: pattern=encoding (like *.php=ISO-8859-1).

# See also: INPUT_ENCODING for further information on supported encodings.

INPUT_FILE_ENCODING =

# 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.