Eigen  3.4.90 (git rev 5a9f66fb35d03a4da9ef8976e67a61b30aa16dcf)
 
Loading...
Searching...
No Matches
Doxyfile
1# Doxyfile 1.11.0
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15#
16# Note:
17#
18# Use doxygen to compare the used configuration file with the template
19# configuration file:
20# doxygen -x [configFile]
21# Use doxygen to compare the used configuration file with the template
22# configuration file without replacing the environment variables or CMake type
23# replacement variables:
24# doxygen -x_noenv [configFile]
25
26#---------------------------------------------------------------------------
27# Project related configuration options
28#---------------------------------------------------------------------------
29
30# This tag specifies the encoding used for all characters in the configuration
31# file that follow. The default is UTF-8 which is also the encoding used for all
32# text before the first occurrence of this tag. Doxygen uses libiconv (or the
33# iconv built into libc) for the transcoding. See
34# https://www.gnu.org/software/libiconv/ for the list of possible encodings.
35# The default value is: UTF-8.
36
37DOXYFILE_ENCODING = UTF-8
38
39# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
40# double-quotes, unless you are using Doxywizard) that should identify the
41# project for which the documentation is generated. This name is used in the
42# title of most generated pages and in a few other places.
43# The default value is: My Project.
44
45PROJECT_NAME = Eigen
46
47# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
48# could be handy for archiving the generated documentation or if some version
49# control system is used.
50
51PROJECT_NUMBER =
52
53# Using the PROJECT_BRIEF tag one can provide an optional one line description
54# for a project that appears at the top of each page and should give viewer a
55# quick idea about the purpose of the project. Keep the description short.
56
57PROJECT_BRIEF =
58
59# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
60# in the documentation. The maximum height of the logo should not exceed 55
61# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
62# the logo to the output directory.
63
64PROJECT_LOGO = /doc/Eigen_Silly_Professor_64x64.png
65
66# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
67# when the HTML document is shown. Doxygen will copy the logo to the output
68# directory.
69
70PROJECT_ICON =
71
72# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
73# into which the generated documentation will be written. If a relative path is
74# entered, it will be relative to the location where doxygen was started. If
75# left blank the current directory will be used.
76
77OUTPUT_DIRECTORY = /doc
78
79# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
80# sub-directories (in 2 levels) under the output directory of each output format
81# and will distribute the generated files over these directories. Enabling this
82# option can be useful when feeding doxygen a huge amount of source files, where
83# putting all generated files in the same directory would otherwise causes
84# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to
85# control the number of sub-directories.
86# The default value is: NO.
87
88CREATE_SUBDIRS = NO
89
90# Controls the number of sub-directories that will be created when
91# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
92# level increment doubles the number of directories, resulting in 4096
93# directories at level 8 which is the default and also the maximum value. The
94# sub-directories are organized in 2 levels, the first level always has a fixed
95# number of 16 directories.
96# Minimum value: 0, maximum value: 8, default value: 8.
97# This tag requires that the tag CREATE_SUBDIRS is set to YES.
98
99CREATE_SUBDIRS_LEVEL = 8
100
101# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
102# characters to appear in the names of generated files. If set to NO, non-ASCII
103# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
104# U+3044.
105# The default value is: NO.
106
107ALLOW_UNICODE_NAMES = NO
108
109# The OUTPUT_LANGUAGE tag is used to specify the language in which all
110# documentation generated by doxygen is written. Doxygen will use this
111# information to generate all constant output in the proper language.
112# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian,
113# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
114# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
115# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
116# English messages), Korean, Korean-en (Korean with English messages), Latvian,
117# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
118# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
119# Swedish, Turkish, Ukrainian and Vietnamese.
120# The default value is: English.
121
122OUTPUT_LANGUAGE = English
123
124# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
125# descriptions after the members that are listed in the file and class
126# documentation (similar to Javadoc). Set to NO to disable this.
127# The default value is: YES.
128
129BRIEF_MEMBER_DESC = YES
130
131# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
132# description of a member or function before the detailed description
133#
134# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
135# brief descriptions will be completely suppressed.
136# The default value is: YES.
137
138REPEAT_BRIEF = YES
139
140# This tag implements a quasi-intelligent brief description abbreviator that is
141# used to form the text in various listings. Each string in this list, if found
142# as the leading text of the brief description, will be stripped from the text
143# and the result, after processing the whole list, is used as the annotated
144# text. Otherwise, the brief description is used as-is. If left blank, the
145# following values are used ($name is automatically replaced with the name of
146# the entity):The $name class, The $name widget, The $name file, is, provides,
147# specifies, contains, represents, a, an and the.
148
149ABBREVIATE_BRIEF = "The $name class" \
150 "The $name widget" \
151 "The $name file" \
152 is \
153 provides \
154 specifies \
155 contains \
156 represents \
157 a \
158 an \
159 the
160
161# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
162# doxygen will generate a detailed section even if there is only a brief
163# description.
164# The default value is: NO.
165
166ALWAYS_DETAILED_SEC = NO
167
168# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
169# inherited members of a class in the documentation of that class as if those
170# members were ordinary class members. Constructors, destructors and assignment
171# operators of the base classes will not be shown.
172# The default value is: NO.
173
174INLINE_INHERITED_MEMB = NO
175
176# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
177# before files name in the file list and in the header files. If set to NO the
178# shortest path that makes the file name unique will be used
179# The default value is: YES.
180
181FULL_PATH_NAMES = NO
182
183# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
184# Stripping is only done if one of the specified strings matches the left-hand
185# part of the path. The tag can be used to show relative paths in the file list.
186# If left blank the directory from which doxygen is run is used as the path to
187# strip.
188#
189# Note that you can specify absolute paths here, but also relative paths, which
190# will be relative from the directory where doxygen is started.
191# This tag requires that the tag FULL_PATH_NAMES is set to YES.
192
193STRIP_FROM_PATH =
194
195# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
196# path mentioned in the documentation of a class, which tells the reader which
197# header file to include in order to use a class. If left blank only the name of
198# the header file containing the class definition is used. Otherwise one should
199# specify the list of include paths that are normally passed to the compiler
200# using the -I flag.
201
202STRIP_FROM_INC_PATH =
203
204# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
205# less readable) file names. This can be useful is your file systems doesn't
206# support long names like on DOS, Mac, or CD-ROM.
207# The default value is: NO.
208
209SHORT_NAMES = NO
210
211# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
212# first line (until the first dot) of a Javadoc-style comment as the brief
213# description. If set to NO, the Javadoc-style will behave just like regular Qt-
214# style comments (thus requiring an explicit @brief command for a brief
215# description.)
216# The default value is: NO.
217
218JAVADOC_AUTOBRIEF = NO
219
220# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
221# such as
222# /***************
223# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
224# Javadoc-style will behave just like regular comments and it will not be
225# interpreted by doxygen.
226# The default value is: NO.
227
228JAVADOC_BANNER = NO
229
230# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
231# line (until the first dot) of a Qt-style comment as the brief description. If
232# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
233# requiring an explicit \brief command for a brief description.)
234# The default value is: NO.
235
236QT_AUTOBRIEF = NO
237
238# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
239# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
240# a brief description. This used to be the default behavior. The new default is
241# to treat a multi-line C++ comment block as a detailed description. Set this
242# tag to YES if you prefer the old behavior instead.
243#
244# Note that setting this tag to YES also means that rational rose comments are
245# not recognized any more.
246# The default value is: NO.
247
248MULTILINE_CPP_IS_BRIEF = NO
249
250# By default Python docstrings are displayed as preformatted text and doxygen's
251# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
252# doxygen's special commands can be used and the contents of the docstring
253# documentation blocks is shown as doxygen documentation.
254# The default value is: YES.
255
256PYTHON_DOCSTRING = YES
257
258# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
259# documentation from any documented member that it re-implements.
260# The default value is: YES.
261
262INHERIT_DOCS = YES
263
264# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
265# page for each member. If set to NO, the documentation of a member will be part
266# of the file/class/namespace that contains it.
267# The default value is: NO.
268
269SEPARATE_MEMBER_PAGES = NO
270
271# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
272# uses this value to replace tabs by spaces in code fragments.
273# Minimum value: 1, maximum value: 16, default value: 4.
274
275TAB_SIZE = 8
276
277# This tag can be used to specify a number of aliases that act as commands in
278# the documentation. An alias has the form:
279# name=value
280# For example adding
281# "sideeffect=@par Side Effects:^^"
282# will allow you to put the command \sideeffect (or @sideeffect) in the
283# documentation, which will result in a user-defined paragraph with heading
284# "Side Effects:". Note that you cannot put \n's in the value part of an alias
285# to insert newlines (in the resulting output). You can put ^^ in the value part
286# of an alias to insert a newline as if a physical newline was in the original
287# file. When you need a literal { or } or , in the value part of an alias you
288# have to escape them by means of a backslash (\‍), this can lead to conflicts
289# with the commands \{ and \} for these it is advised to use the version @{ and
290# @} or use a double escape (\\{ and \\})
291
292ALIASES = "only_for_vectors=This is only for vectors (either row-vectors or column-vectors), i.e. matrices which are known at compile-time to have either one row or one column." \
293 "not_reentrant=\warning This function is not re-entrant." \
294 "array_module=This is defined in the %Array module. \code #include <Eigen/Array> \endcode" \
295 "cholesky_module=This is defined in the %Cholesky module. \code #include <Eigen/Cholesky> \endcode" \
296 "eigenvalues_module=This is defined in the %Eigenvalues module. \code #include <Eigen/Eigenvalues> \endcode" \
297 "geometry_module=This is defined in the %Geometry module. \code #include <Eigen/Geometry> \endcode" \
298 "householder_module=This is defined in the %Householder module. \code #include <Eigen/Householder> \endcode" \
299 "jacobi_module=This is defined in the %Jacobi module. \code #include <Eigen/Jacobi> \endcode" \
300 "lu_module=This is defined in the %LU module. \code #include <Eigen/LU> \endcode" \
301 "qr_module=This is defined in the %QR module. \code #include <Eigen/QR> \endcode" \
302 "svd_module=This is defined in the %SVD module. \code #include <Eigen/SVD> \endcode" \
303 "specialfunctions_module=This is defined in the \b unsupported SpecialFunctions module. \code #include <Eigen/SpecialFunctions> \endcode" \
304 "label=\bug" \
305 "matrixworld=<a href='#matrixonly' style='color:green;text-decoration: none;'>*</a>" \
306 "arrayworld=<a href='#arrayonly' style='color:blue;text-decoration: none;'>*</a>" \
307 "note_about_arbitrary_choice_of_solution=If there exists more than one solution, this method will arbitrarily choose one." \
308 "note_about_using_kernel_to_study_multiple_solutions=If you need a complete analysis of the space of solutions, take the one solution obtained by this method and add to it elements of the kernel, as determined by kernel()." \
309 "note_about_checking_solutions=This method just tries to find as good a solution as possible. If you want to check whether a solution exists or if it is accurate, just call this function to get a result and then compute the error of this result, or use MatrixBase::isApprox() directly, for instance like this: \code bool a_solution_exists = (A*result).isApprox(b, precision); \endcode This method avoids dividing by zero, so that the non-existence of a solution doesn't by itself mean that you'll get \c inf or \c nan values." \
310 "note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." \
311 "nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\"" \
312 "implsparsesolverconcept=This class follows the \link TutorialSparseSolverConcept sparse solver concept \endlink." \
313 "blank=" \
314 "cpp11=<span class='cpp11'>[c++11]</span>" \
315 "cpp14=<span class='cpp14'>[c++14]</span>" \
316 "cpp17=<span class='cpp17'>[c++17]</span>" \
317 "newin{1}=<span class='newin3x'>New in %Eigen \1.</span>" \
318 "eigenAutoToc= " \
319 "eigenManualPage=\defgroup"
320
321# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
322# only. Doxygen will then generate output that is more tailored for C. For
323# instance, some of the names that are used will be different. The list of all
324# members will be omitted, etc.
325# The default value is: NO.
326
327OPTIMIZE_OUTPUT_FOR_C = NO
328
329# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
330# Python sources only. Doxygen will then generate output that is more tailored
331# for that language. For instance, namespaces will be presented as packages,
332# qualified scopes will look different, etc.
333# The default value is: NO.
334
335OPTIMIZE_OUTPUT_JAVA = NO
336
337# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
338# sources. Doxygen will then generate output that is tailored for Fortran.
339# The default value is: NO.
340
341OPTIMIZE_FOR_FORTRAN = NO
342
343# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
344# sources. Doxygen will then generate output that is tailored for VHDL.
345# The default value is: NO.
346
347OPTIMIZE_OUTPUT_VHDL = NO
348
349# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
350# sources only. Doxygen will then generate output that is more tailored for that
351# language. For instance, namespaces will be presented as modules, types will be
352# separated into more groups, etc.
353# The default value is: NO.
354
355OPTIMIZE_OUTPUT_SLICE = NO
356
357# Doxygen selects the parser to use depending on the extension of the files it
358# parses. With this tag you can assign which parser to use for a given
359# extension. Doxygen has a built-in mapping, but you can override or extend it
360# using this tag. The format is ext=language, where ext is a file extension, and
361# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
362# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
363# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
364# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
365# tries to guess whether the code is fixed or free formatted code, this is the
366# default for Fortran type files). For instance to make doxygen treat .inc files
367# as Fortran files (default is PHP), and .f files as C (default is Fortran),
368# use: inc=Fortran f=C.
369#
370# Note: For files without extension you can use no_extension as a placeholder.
371#
372# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
373# the files are not read by doxygen. When specifying no_extension you should add
374# * to the FILE_PATTERNS.
375#
376# Note see also the list of default file extension mappings.
377
378EXTENSION_MAPPING = .h=C++ \
379 no_extension=C++
380
381# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
382# according to the Markdown format, which allows for more readable
383# documentation. See https://daringfireball.net/projects/markdown/ for details.
384# The output of markdown processing is further processed by doxygen, so you can
385# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
386# case of backward compatibilities issues.
387# The default value is: YES.
388
389MARKDOWN_SUPPORT = YES
390
391# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
392# to that level are automatically included in the table of contents, even if
393# they do not have an id attribute.
394# Note: This feature currently applies only to Markdown headings.
395# Minimum value: 0, maximum value: 99, default value: 6.
396# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
397
398TOC_INCLUDE_HEADINGS = 6
399
400# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
401# generate identifiers for the Markdown headings. Note: Every identifier is
402# unique.
403# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
404# sequence number starting at 0 and GITHUB use the lower case version of title
405# with any whitespace replaced by '-' and punctuation characters removed.
406# The default value is: DOXYGEN.
407# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
408
409MARKDOWN_ID_STYLE = DOXYGEN
410
411# When enabled doxygen tries to link words that correspond to documented
412# classes, or namespaces to their corresponding documentation. Such a link can
413# be prevented in individual cases by putting a % sign in front of the word or
414# globally by setting AUTOLINK_SUPPORT to NO.
415# The default value is: YES.
416
417AUTOLINK_SUPPORT = YES
418
419# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
420# to include (a tag file for) the STL sources as input, then you should set this
421# tag to YES in order to let doxygen match functions declarations and
422# definitions whose arguments contain STL classes (e.g. func(std::string);
423# versus func(std::string) {}). This also makes the inheritance and
424# collaboration diagrams that involve STL classes more complete and accurate.
425# The default value is: NO.
426
427BUILTIN_STL_SUPPORT = NO
428
429# If you use Microsoft's C++/CLI language, you should set this option to YES to
430# enable parsing support.
431# The default value is: NO.
432
433CPP_CLI_SUPPORT = NO
434
435# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
436# https://www.riverbankcomputing.com/software) sources only. Doxygen will parse
437# them like normal C++ but will assume all classes use public instead of private
438# inheritance when no explicit protection keyword is present.
439# The default value is: NO.
440
441SIP_SUPPORT = NO
442
443# For Microsoft's IDL there are propget and propput attributes to indicate
444# getter and setter methods for a property. Setting this option to YES will make
445# doxygen to replace the get and set methods by a property in the documentation.
446# This will only work if the methods are indeed getting or setting a simple
447# type. If this is not the case, or you want to show the methods anyway, you
448# should set this option to NO.
449# The default value is: YES.
450
451IDL_PROPERTY_SUPPORT = YES
452
453# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
454# tag is set to YES then doxygen will reuse the documentation of the first
455# member in the group (if any) for the other members of the group. By default
456# all members of a group must be documented explicitly.
457# The default value is: NO.
458
459DISTRIBUTE_GROUP_DOC = YES
460
461# If one adds a struct or class to a group and this option is enabled, then also
462# any nested class or struct is added to the same group. By default this option
463# is disabled and one has to add nested compounds explicitly via \ingroup.
464# The default value is: NO.
465
466GROUP_NESTED_COMPOUNDS = NO
467
468# Set the SUBGROUPING tag to YES to allow class member groups of the same type
469# (for instance a group of public functions) to be put as a subgroup of that
470# type (e.g. under the Public Functions section). Set it to NO to prevent
471# subgrouping. Alternatively, this can be done per class using the
472# \nosubgrouping command.
473# The default value is: YES.
474
475SUBGROUPING = YES
476
477# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
478# are shown inside the group in which they are included (e.g. using \ingroup)
479# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
480# and RTF).
481#
482# Note that this feature does not work in combination with
483# SEPARATE_MEMBER_PAGES.
484# The default value is: NO.
485
486INLINE_GROUPED_CLASSES = NO
487
488# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
489# with only public data fields or simple typedef fields will be shown inline in
490# the documentation of the scope in which they are defined (i.e. file,
491# namespace, or group documentation), provided this scope is documented. If set
492# to NO, structs, classes, and unions are shown on a separate page (for HTML and
493# Man pages) or section (for LaTeX and RTF).
494# The default value is: NO.
495
496INLINE_SIMPLE_STRUCTS = NO
497
498# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
499# enum is documented as struct, union, or enum with the name of the typedef. So
500# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
501# with name TypeT. When disabled the typedef will appear as a member of a file,
502# namespace, or class. And the struct will be named TypeS. This can typically be
503# useful for C code in case the coding convention dictates that all compound
504# types are typedef'ed and only the typedef is referenced, never the tag name.
505# The default value is: NO.
506
507TYPEDEF_HIDES_STRUCT = NO
508
509# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
510# cache is used to resolve symbols given their name and scope. Since this can be
511# an expensive process and often the same symbol appears multiple times in the
512# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
513# doxygen will become slower. If the cache is too large, memory is wasted. The
514# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
515# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
516# symbols. At the end of a run doxygen will report the cache usage and suggest
517# the optimal cache size from a speed point of view.
518# Minimum value: 0, maximum value: 9, default value: 0.
519
520LOOKUP_CACHE_SIZE = 0
521
522# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
523# during processing. When set to 0 doxygen will based this on the number of
524# cores available in the system. You can set it explicitly to a value larger
525# than 0 to get more control over the balance between CPU load and processing
526# speed. At this moment only the input processing can be done using multiple
527# threads. Since this is still an experimental feature the default is set to 1,
528# which effectively disables parallel processing. Please report any issues you
529# encounter. Generating dot graphs in parallel is controlled by the
530# DOT_NUM_THREADS setting.
531# Minimum value: 0, maximum value: 32, default value: 1.
532
533NUM_PROC_THREADS = 1
534
535# If the TIMESTAMP tag is set different from NO then each generated page will
536# contain the date or date and time when the page was generated. Setting this to
537# NO can help when comparing the output of multiple runs.
538# Possible values are: YES, NO, DATETIME and DATE.
539# The default value is: NO.
540
541TIMESTAMP = YES
542
543#---------------------------------------------------------------------------
544# Build related configuration options
545#---------------------------------------------------------------------------
546
547# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
548# documentation are documented, even if no documentation was available. Private
549# class members and static file members will be hidden unless the
550# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
551# Note: This will also disable the warnings about undocumented members that are
552# normally produced when WARNINGS is set to YES.
553# The default value is: NO.
554
555EXTRACT_ALL = NO
556
557# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
558# be included in the documentation.
559# The default value is: NO.
560
561EXTRACT_PRIVATE = NO
562
563# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
564# methods of a class will be included in the documentation.
565# The default value is: NO.
566
567EXTRACT_PRIV_VIRTUAL = NO
568
569# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
570# scope will be included in the documentation.
571# The default value is: NO.
572
573EXTRACT_PACKAGE = NO
574
575# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
576# included in the documentation.
577# The default value is: NO.
578
579EXTRACT_STATIC = YES
580
581# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
582# locally in source files will be included in the documentation. If set to NO,
583# only classes defined in header files are included. Does not have any effect
584# for Java sources.
585# The default value is: YES.
586
587EXTRACT_LOCAL_CLASSES = NO
588
589# This flag is only useful for Objective-C code. If set to YES, local methods,
590# which are defined in the implementation section but not in the interface are
591# included in the documentation. If set to NO, only methods in the interface are
592# included.
593# The default value is: NO.
594
595EXTRACT_LOCAL_METHODS = NO
596
597# If this flag is set to YES, the members of anonymous namespaces will be
598# extracted and appear in the documentation as a namespace called
599# 'anonymous_namespace{file}', where file will be replaced with the base name of
600# the file that contains the anonymous namespace. By default anonymous namespace
601# are hidden.
602# The default value is: NO.
603
604EXTRACT_ANON_NSPACES = NO
605
606# If this flag is set to YES, the name of an unnamed parameter in a declaration
607# will be determined by the corresponding definition. By default unnamed
608# parameters remain unnamed in the output.
609# The default value is: YES.
610
611RESOLVE_UNNAMED_PARAMS = YES
612
613# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
614# undocumented members inside documented classes or files. If set to NO these
615# members will be included in the various overviews, but no documentation
616# section is generated. This option has no effect if EXTRACT_ALL is enabled.
617# The default value is: NO.
618
619HIDE_UNDOC_MEMBERS = YES
620
621# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
622# undocumented classes that are normally visible in the class hierarchy. If set
623# to NO, these classes will be included in the various overviews. This option
624# will also hide undocumented C++ concepts if enabled. This option has no effect
625# if EXTRACT_ALL is enabled.
626# The default value is: NO.
627
628HIDE_UNDOC_CLASSES = YES
629
630# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
631# declarations. If set to NO, these declarations will be included in the
632# documentation.
633# The default value is: NO.
634
635HIDE_FRIEND_COMPOUNDS = YES
636
637# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
638# documentation blocks found inside the body of a function. If set to NO, these
639# blocks will be appended to the function's detailed documentation block.
640# The default value is: NO.
641
642HIDE_IN_BODY_DOCS = NO
643
644# The INTERNAL_DOCS tag determines if documentation that is typed after a
645# \internal command is included. If the tag is set to NO then the documentation
646# will be excluded. Set it to YES to include the internal documentation.
647# The default value is: NO.
648
649INTERNAL_DOCS = NO
650
651# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
652# able to match the capabilities of the underlying filesystem. In case the
653# filesystem is case sensitive (i.e. it supports files in the same directory
654# whose names only differ in casing), the option must be set to YES to properly
655# deal with such files in case they appear in the input. For filesystems that
656# are not case sensitive the option should be set to NO to properly deal with
657# output files written for symbols that only differ in casing, such as for two
658# classes, one named CLASS and the other named Class, and to also support
659# references to files without having to specify the exact matching casing. On
660# Windows (including Cygwin) and MacOS, users should typically set this option
661# to NO, whereas on Linux or other Unix flavors it should typically be set to
662# YES.
663# Possible values are: SYSTEM, NO and YES.
664# The default value is: SYSTEM.
665
666CASE_SENSE_NAMES = YES
667
668# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
669# their full class and namespace scopes in the documentation. If set to YES, the
670# scope will be hidden.
671# The default value is: NO.
672
673HIDE_SCOPE_NAMES = NO
674
675# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
676# append additional text to a page's title, such as Class Reference. If set to
677# YES the compound reference will be hidden.
678# The default value is: NO.
679
680HIDE_COMPOUND_REFERENCE= NO
681
682# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
683# will show which file needs to be included to use the class.
684# The default value is: YES.
685
686SHOW_HEADERFILE = YES
687
688# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
689# the files that are included by a file in the documentation of that file.
690# The default value is: YES.
691
692SHOW_INCLUDE_FILES = NO
693
694# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
695# grouped member an include statement to the documentation, telling the reader
696# which file to include in order to use the member.
697# The default value is: NO.
698
699SHOW_GROUPED_MEMB_INC = NO
700
701# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
702# files with double quotes in the documentation rather than with sharp brackets.
703# The default value is: NO.
704
705FORCE_LOCAL_INCLUDES = NO
706
707# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
708# documentation for inline members.
709# The default value is: YES.
710
711INLINE_INFO = YES
712
713# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
714# (detailed) documentation of file and class members alphabetically by member
715# name. If set to NO, the members will appear in declaration order.
716# The default value is: YES.
717
718SORT_MEMBER_DOCS = YES
719
720# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
721# descriptions of file, namespace and class members alphabetically by member
722# name. If set to NO, the members will appear in declaration order. Note that
723# this will also influence the order of the classes in the class list.
724# The default value is: NO.
725
726SORT_BRIEF_DOCS = YES
727
728# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
729# (brief and detailed) documentation of class members so that constructors and
730# destructors are listed first. If set to NO the constructors will appear in the
731# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
732# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
733# member documentation.
734# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
735# detailed member documentation.
736# The default value is: NO.
737
738SORT_MEMBERS_CTORS_1ST = NO
739
740# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
741# of group names into alphabetical order. If set to NO the group names will
742# appear in their defined order.
743# The default value is: NO.
744
745SORT_GROUP_NAMES = NO
746
747# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
748# fully-qualified names, including namespaces. If set to NO, the class list will
749# be sorted only by class name, not including the namespace part.
750# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
751# Note: This option applies only to the class list, not to the alphabetical
752# list.
753# The default value is: NO.
754
755SORT_BY_SCOPE_NAME = NO
756
757# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
758# type resolution of all parameters of a function it will reject a match between
759# the prototype and the implementation of a member function even if there is
760# only one candidate or it is obvious which candidate to choose by doing a
761# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
762# accept a match between prototype and implementation in such cases.
763# The default value is: NO.
764
765STRICT_PROTO_MATCHING = NO
766
767# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
768# list. This list is created by putting \todo commands in the documentation.
769# The default value is: YES.
770
771GENERATE_TODOLIST = NO
772
773# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
774# list. This list is created by putting \test commands in the documentation.
775# The default value is: YES.
776
777GENERATE_TESTLIST = NO
778
779# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
780# list. This list is created by putting \bug commands in the documentation.
781# The default value is: YES.
782
783GENERATE_BUGLIST = NO
784
785# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
786# the deprecated list. This list is created by putting \deprecated commands in
787# the documentation.
788# The default value is: YES.
789
790GENERATE_DEPRECATEDLIST= YES
791
792# The ENABLED_SECTIONS tag can be used to enable conditional documentation
793# sections, marked by \if <section_label> ... \endif and \cond <section_label>
794# ... \endcond blocks.
795
796ENABLED_SECTIONS =
797
798# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
799# initial value of a variable or macro / define can have for it to appear in the
800# documentation. If the initializer consists of more lines than specified here
801# it will be hidden. Use a value of 0 to hide initializers completely. The
802# appearance of the value of individual variables and macros / defines can be
803# controlled using \showinitializer or \hideinitializer command in the
804# documentation regardless of this setting.
805# Minimum value: 0, maximum value: 10000, default value: 30.
806
807MAX_INITIALIZER_LINES = 0
808
809# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
810# the bottom of the documentation of classes and structs. If set to YES, the
811# list will mention the files that were used to generate the documentation.
812# The default value is: YES.
813
814SHOW_USED_FILES = YES
815
816# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
817# will remove the Files entry from the Quick Index and from the Folder Tree View
818# (if specified).
819# The default value is: YES.
820
821SHOW_FILES = YES
822
823# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
824# page. This will remove the Namespaces entry from the Quick Index and from the
825# Folder Tree View (if specified).
826# The default value is: YES.
827
828SHOW_NAMESPACES = NO
829
830# The FILE_VERSION_FILTER tag can be used to specify a program or script that
831# doxygen should invoke to get the current version for each file (typically from
832# the version control system). Doxygen will invoke the program by executing (via
833# popen()) the command command input-file, where command is the value of the
834# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
835# by doxygen. Whatever the program writes to standard output is used as the file
836# version. For an example see the documentation.
837
838FILE_VERSION_FILTER =
839
840# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
841# by doxygen. The layout file controls the global structure of the generated
842# output files in an output format independent way. To create the layout file
843# that represents doxygen's defaults, run doxygen with the -l option. You can
844# optionally specify a file name after the option, if omitted DoxygenLayout.xml
845# will be used as the name of the layout file. See also section "Changing the
846# layout of pages" for information.
847#
848# Note that if you run doxygen from a directory containing a file called
849# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
850# tag is left empty.
851
852LAYOUT_FILE = /doc/eigendoxy_layout.xml
853
854# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
855# the reference definitions. This must be a list of .bib files. The .bib
856# extension is automatically appended if omitted. This requires the bibtex tool
857# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
858# For LaTeX the style of the bibliography can be controlled using
859# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
860# search path. See also \cite for info how to create references.
861
862CITE_BIB_FILES =
863
864#---------------------------------------------------------------------------
865# Configuration options related to warning and progress messages
866#---------------------------------------------------------------------------
867
868# The QUIET tag can be used to turn on/off the messages that are generated to
869# standard output by doxygen. If QUIET is set to YES this implies that the
870# messages are off.
871# The default value is: NO.
872
873QUIET = NO
874
875# The WARNINGS tag can be used to turn on/off the warning messages that are
876# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
877# this implies that the warnings are on.
878#
879# Tip: Turn warnings on while writing the documentation.
880# The default value is: YES.
881
882WARNINGS = YES
883
884# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
885# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
886# will automatically be disabled.
887# The default value is: YES.
888
889WARN_IF_UNDOCUMENTED = NO
890
891# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
892# potential errors in the documentation, such as documenting some parameters in
893# a documented function twice, or documenting parameters that don't exist or
894# using markup commands wrongly.
895# The default value is: YES.
896
897WARN_IF_DOC_ERROR = YES
898
899# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
900# function parameter documentation. If set to NO, doxygen will accept that some
901# parameters have no documentation without warning.
902# The default value is: YES.
903
904WARN_IF_INCOMPLETE_DOC = YES
905
906# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
907# are documented, but have no documentation for their parameters or return
908# value. If set to NO, doxygen will only warn about wrong parameter
909# documentation, but not about the absence of documentation. If EXTRACT_ALL is
910# set to YES then this flag will automatically be disabled. See also
911# WARN_IF_INCOMPLETE_DOC
912# The default value is: NO.
913
914WARN_NO_PARAMDOC = NO
915
916# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
917# undocumented enumeration values. If set to NO, doxygen will accept
918# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
919# will automatically be disabled.
920# The default value is: NO.
921
922WARN_IF_UNDOC_ENUM_VAL = NO
923
924# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
925# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
926# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
927# at the end of the doxygen process doxygen will return with a non-zero status.
928# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
929# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
930# write the warning messages in between other messages but write them at the end
931# of a run, in case a WARN_LOGFILE is defined the warning messages will be
932# besides being in the defined file also be shown at the end of a run, unless
933# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
934# the behavior will remain as with the setting FAIL_ON_WARNINGS.
935# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
936# The default value is: NO.
937
938WARN_AS_ERROR = NO
939
940# The WARN_FORMAT tag determines the format of the warning messages that doxygen
941# can produce. The string should contain the $file, $line, and $text tags, which
942# will be replaced by the file and line number from which the warning originated
943# and the warning text. Optionally the format may contain $version, which will
944# be replaced by the version of the file (if it could be obtained via
945# FILE_VERSION_FILTER)
946# See also: WARN_LINE_FORMAT
947# The default value is: $file:$line: $text.
948
949WARN_FORMAT = "$file:$line: $text"
950
951# In the $text part of the WARN_FORMAT command it is possible that a reference
952# to a more specific place is given. To make it easier to jump to this place
953# (outside of doxygen) the user can define a custom "cut" / "paste" string.
954# Example:
955# WARN_LINE_FORMAT = "'vi $file +$line'"
956# See also: WARN_FORMAT
957# The default value is: at line $line of file $file.
958
959WARN_LINE_FORMAT = "at line $line of file $file"
960
961# The WARN_LOGFILE tag can be used to specify a file to which warning and error
962# messages should be written. If left blank the output is written to standard
963# error (stderr). In case the file specified cannot be opened for writing the
964# warning and error messages are written to standard error. When as file - is
965# specified the warning and error messages are written to standard output
966# (stdout).
967
968WARN_LOGFILE =
969
970#---------------------------------------------------------------------------
971# Configuration options related to the input files
972#---------------------------------------------------------------------------
973
974# The INPUT tag is used to specify the files and/or directories that contain
975# documented source files. You may enter file names like myfile.cpp or
976# directories like /usr/src/myproject. Separate the files or directories with
977# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
978# Note: If this tag is empty the current directory is searched.
979
980INPUT = "/Eigen" \
981 "/doc"
982
983# This tag can be used to specify the character encoding of the source files
984# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
985# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
986# documentation (see:
987# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
988# See also: INPUT_FILE_ENCODING
989# The default value is: UTF-8.
990
991INPUT_ENCODING = UTF-8
992
993# This tag can be used to specify the character encoding of the source files
994# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
995# character encoding on a per file pattern basis. Doxygen will compare the file
996# name with each pattern and apply the encoding instead of the default
997# INPUT_ENCODING) if there is a match. The character encodings are a list of the
998# form: pattern=encoding (like *.php=ISO-8859-1).
999# See also: INPUT_ENCODING for further information on supported encodings.
1000
1001INPUT_FILE_ENCODING =
1002
1003# If the value of the INPUT tag contains directories, you can use the
1004# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
1005# *.h) to filter out the source-files in the directories.
1006#
1007# Note that for custom extensions or not directly supported extensions you also
1008# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1009# read by doxygen.
1010#
1011# Note the list of default checked file patterns might differ from the list of
1012# default file extension mappings.
1013#
1014# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
1015# *.cpp, *.cppm, *.ccm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl,
1016# *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d,
1017# *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to
1018# be provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
1019# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
1020
1021FILE_PATTERNS = *
1022
1023# The RECURSIVE tag can be used to specify whether or not subdirectories should
1024# be searched for input files as well.
1025# The default value is: NO.
1026
1027RECURSIVE = YES
1028
1029# The EXCLUDE tag can be used to specify files and/or directories that should be
1030# excluded from the INPUT source files. This way you can easily exclude a
1031# subdirectory from a directory tree whose root is specified with the INPUT tag.
1032#
1033# Note that relative paths are relative to the directory from which doxygen is
1034# run.
1035
1036EXCLUDE = "/Eigen/src/Core/products" \
1037 "/Eigen/Eigen2Support" \
1038 "/Eigen/src/Eigen2Support" \
1039 "/doc/examples" \
1040 "/doc/special_examples" \
1041 "/doc/snippets" \
1042 "/unsupported/doc/examples" \
1043 "/unsupported/doc/snippets" \
1044 "/Eigen/src/Core/util/ForwardDeclarations.h"
1045
1046# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
1047# directories that are symbolic links (a Unix file system feature) are excluded
1048# from the input.
1049# The default value is: NO.
1050
1051EXCLUDE_SYMLINKS = NO
1052
1053# If the value of the INPUT tag contains directories, you can use the
1054# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
1055# certain files from those directories.
1056#
1057# Note that the wildcards are matched against the file with absolute path, so to
1058# exclude all test directories for example use the pattern */test/*
1059
1060EXCLUDE_PATTERNS = CMake* \
1061 *.txt \
1062 *.sh \
1063 *.orig \
1064 *.diff \
1065 diff \
1066 *~ \
1067 *. \
1068 *.sln \
1069 *.sdf \
1070 *.tmp \
1071 *.vcxproj \
1072 *.filters \
1073 *.user \
1074 *.suo
1075
1076# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
1077# (namespaces, classes, functions, etc.) that should be excluded from the
1078# output. The symbol name can be a fully qualified name, a word, or if the
1079# wildcard * is used, a substring. Examples: ANamespace, AClass,
1080# ANamespace::AClass, ANamespace::*Test
1081
1082EXCLUDE_SYMBOLS = internal::* \
1083 Flagged* \
1084 *InnerIterator* \
1085 DenseStorage<*
1086
1087# The EXAMPLE_PATH tag can be used to specify one or more files or directories
1088# that contain example code fragments that are included (see the \include
1089# command).
1090
1091EXAMPLE_PATH = "/doc/snippets" \
1092 "/doc/snippets" \
1093 "/doc/examples" \
1094 "/doc/examples" \
1095 "/doc/special_examples" \
1096 "/doc/special_examples" \
1097 "/unsupported/doc/snippets" \
1098 "/unsupported/doc/snippets" \
1099 "/unsupported/doc/examples" \
1100 "/unsupported/doc/examples"
1101
1102# If the value of the EXAMPLE_PATH tag contains directories, you can use the
1103# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
1104# *.h) to filter out the source-files in the directories. If left blank all
1105# files are included.
1106
1107EXAMPLE_PATTERNS = *
1108
1109# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
1110# searched for input files to be used with the \include or \dontinclude commands
1111# irrespective of the value of the RECURSIVE tag.
1112# The default value is: NO.
1113
1114EXAMPLE_RECURSIVE = NO
1115
1116# The IMAGE_PATH tag can be used to specify one or more files or directories
1117# that contain images that are to be included in the documentation (see the
1118# \image command).
1119
1120IMAGE_PATH = /doc/html
1121
1122# The INPUT_FILTER tag can be used to specify a program that doxygen should
1123# invoke to filter for each input file. Doxygen will invoke the filter program
1124# by executing (via popen()) the command:
1125#
1126# <filter> <input-file>
1127#
1128# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1129# name of an input file. Doxygen will then use the output that the filter
1130# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1131# will be ignored.
1132#
1133# Note that the filter must not add or remove lines; it is applied before the
1134# code is scanned, but not when the output code is generated. If lines are added
1135# or removed, the anchors will not be placed correctly.
1136#
1137# Note that doxygen will use the data processed and written to standard output
1138# for further processing, therefore nothing else, like debug statements or used
1139# commands (so in case of a Windows batch file always use @echo OFF), should be
1140# written to standard output.
1141#
1142# Note that for custom extensions or not directly supported extensions you also
1143# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1144# properly processed by doxygen.
1145
1146INPUT_FILTER =
1147
1148# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1149# basis. Doxygen will compare the file name with each pattern and apply the
1150# filter if there is a match. The filters are a list of the form: pattern=filter
1151# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1152# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1153# patterns match the file name, INPUT_FILTER is applied.
1154#
1155# Note that for custom extensions or not directly supported extensions you also
1156# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1157# properly processed by doxygen.
1158
1159FILTER_PATTERNS =
1160
1161# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1162# INPUT_FILTER) will also be used to filter the input files that are used for
1163# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1164# The default value is: NO.
1165
1166FILTER_SOURCE_FILES = NO
1167
1168# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1169# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1170# it is also possible to disable source filtering for a specific pattern using
1171# *.ext= (so without naming a filter).
1172# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1173
1174FILTER_SOURCE_PATTERNS =
1175
1176# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1177# is part of the input, its contents will be placed on the main page
1178# (index.html). This can be useful if you have a project on for instance GitHub
1179# and want to reuse the introduction page also for the doxygen output.
1180
1181USE_MDFILE_AS_MAINPAGE =
1182
1183# The Fortran standard specifies that for fixed formatted Fortran code all
1184# characters from position 72 are to be considered as comment. A common
1185# extension is to allow longer lines before the automatic comment starts. The
1186# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
1187# be processed before the automatic comment starts.
1188# Minimum value: 7, maximum value: 10000, default value: 72.
1189
1190FORTRAN_COMMENT_AFTER = 72
1191
1192#---------------------------------------------------------------------------
1193# Configuration options related to source browsing
1194#---------------------------------------------------------------------------
1195
1196# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1197# generated. Documented entities will be cross-referenced with these sources.
1198#
1199# Note: To get rid of all source code in the generated output, make sure that
1200# also VERBATIM_HEADERS is set to NO.
1201# The default value is: NO.
1202
1203SOURCE_BROWSER = NO
1204
1205# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1206# multi-line macros, enums or list initialized variables directly into the
1207# documentation.
1208# The default value is: NO.
1209
1210INLINE_SOURCES = NO
1211
1212# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1213# special comment blocks from generated source code fragments. Normal C, C++ and
1214# Fortran comments will always remain visible.
1215# The default value is: YES.
1216
1217STRIP_CODE_COMMENTS = YES
1218
1219# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1220# entity all documented functions referencing it will be listed.
1221# The default value is: NO.
1222
1223REFERENCED_BY_RELATION = NO
1224
1225# If the REFERENCES_RELATION tag is set to YES then for each documented function
1226# all documented entities called/used by that function will be listed.
1227# The default value is: NO.
1228
1229REFERENCES_RELATION = NO
1230
1231# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1232# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1233# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1234# link to the documentation.
1235# The default value is: YES.
1236
1237REFERENCES_LINK_SOURCE = YES
1238
1239# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1240# source code will show a tooltip with additional information such as prototype,
1241# brief description and links to the definition and documentation. Since this
1242# will make the HTML file larger and loading of large files a bit slower, you
1243# can opt to disable this feature.
1244# The default value is: YES.
1245# This tag requires that the tag SOURCE_BROWSER is set to YES.
1246
1247SOURCE_TOOLTIPS = YES
1248
1249# If the USE_HTAGS tag is set to YES then the references to source code will
1250# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1251# source browser. The htags tool is part of GNU's global source tagging system
1252# (see https://www.gnu.org/software/global/global.html). You will need version
1253# 4.8.6 or higher.
1254#
1255# To use it do the following:
1256# - Install the latest version of global
1257# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1258# - Make sure the INPUT points to the root of the source tree
1259# - Run doxygen as normal
1260#
1261# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1262# tools must be available from the command line (i.e. in the search path).
1263#
1264# The result: instead of the source browser generated by doxygen, the links to
1265# source code will now point to the output of htags.
1266# The default value is: NO.
1267# This tag requires that the tag SOURCE_BROWSER is set to YES.
1268
1269USE_HTAGS = NO
1270
1271# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1272# verbatim copy of the header file for each class for which an include is
1273# specified. Set to NO to disable this.
1274# See also: Section \class.
1275# The default value is: YES.
1276
1277VERBATIM_HEADERS = YES
1278
1279#---------------------------------------------------------------------------
1280# Configuration options related to the alphabetical class index
1281#---------------------------------------------------------------------------
1282
1283# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1284# compounds will be generated. Enable this if the project contains a lot of
1285# classes, structs, unions or interfaces.
1286# The default value is: YES.
1287
1288ALPHABETICAL_INDEX = NO
1289
1290# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes)
1291# that should be ignored while generating the index headers. The IGNORE_PREFIX
1292# tag works for classes, function and member names. The entity will be placed in
1293# the alphabetical list under the first letter of the entity name that remains
1294# after removing the prefix.
1295# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1296
1297IGNORE_PREFIX =
1298
1299#---------------------------------------------------------------------------
1300# Configuration options related to the HTML output
1301#---------------------------------------------------------------------------
1302
1303# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1304# The default value is: YES.
1305
1306GENERATE_HTML = YES
1307
1308# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1309# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1310# it.
1311# The default directory is: html.
1312# This tag requires that the tag GENERATE_HTML is set to YES.
1313
1314HTML_OUTPUT = /doc/html
1315
1316# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1317# generated HTML page (for example: .htm, .php, .asp).
1318# The default value is: .html.
1319# This tag requires that the tag GENERATE_HTML is set to YES.
1320
1321HTML_FILE_EXTENSION = .html
1322
1323# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1324# each generated HTML page. If the tag is left blank doxygen will generate a
1325# standard header.
1326#
1327# To get valid HTML the header file that includes any scripts and style sheets
1328# that doxygen needs, which is dependent on the configuration options used (e.g.
1329# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1330# default header using
1331# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1332# YourConfigFile
1333# and then modify the file new_header.html. See also section "Doxygen usage"
1334# for information on how to generate the default header that doxygen normally
1335# uses.
1336# Note: The header is subject to change so you typically have to regenerate the
1337# default header when upgrading to a newer version of doxygen. For a description
1338# of the possible markers and block names see the documentation.
1339# This tag requires that the tag GENERATE_HTML is set to YES.
1340
1341HTML_HEADER = /doc/eigendoxy_header.html
1342
1343# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1344# generated HTML page. If the tag is left blank doxygen will generate a standard
1345# footer. See HTML_HEADER for more information on how to generate a default
1346# footer and what special commands can be used inside the footer. See also
1347# section "Doxygen usage" for information on how to generate the default footer
1348# that doxygen normally uses.
1349# This tag requires that the tag GENERATE_HTML is set to YES.
1350
1351HTML_FOOTER = /doc/eigendoxy_footer.html
1352
1353# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1354# sheet that is used by each HTML page. It can be used to fine-tune the look of
1355# the HTML output. If left blank doxygen will generate a default style sheet.
1356# See also section "Doxygen usage" for information on how to generate the style
1357# sheet that doxygen normally uses.
1358# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1359# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1360# obsolete.
1361# This tag requires that the tag GENERATE_HTML is set to YES.
1362
1363HTML_STYLESHEET =
1364
1365# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1366# cascading style sheets that are included after the standard style sheets
1367# created by doxygen. Using this option one can overrule certain style aspects.
1368# This is preferred over using HTML_STYLESHEET since it does not replace the
1369# standard style sheet and is therefore more robust against future updates.
1370# Doxygen will copy the style sheet files to the output directory.
1371# Note: The order of the extra style sheet files is of importance (e.g. the last
1372# style sheet in the list overrules the setting of the previous ones in the
1373# list).
1374# Note: Since the styling of scrollbars can currently not be overruled in
1375# Webkit/Chromium, the styling will be left out of the default doxygen.css if
1376# one or more extra stylesheets have been specified. So if scrollbar
1377# customization is desired it has to be added explicitly. For an example see the
1378# documentation.
1379# This tag requires that the tag GENERATE_HTML is set to YES.
1380
1381HTML_EXTRA_STYLESHEET =
1382
1383# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1384# other source files which should be copied to the HTML output directory. Note
1385# that these files will be copied to the base HTML output directory. Use the
1386# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1387# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1388# files will be copied as-is; there are no commands or markers available.
1389# This tag requires that the tag GENERATE_HTML is set to YES.
1390
1391HTML_EXTRA_FILES = "/doc/eigendoxy.css"
1392
1393# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
1394# should be rendered with a dark or light theme.
1395# Possible values are: LIGHT always generates light mode output, DARK always
1396# generates dark mode output, AUTO_LIGHT automatically sets the mode according
1397# to the user preference, uses light mode if no preference is set (the default),
1398# AUTO_DARK automatically sets the mode according to the user preference, uses
1399# dark mode if no preference is set and TOGGLE allows a user to switch between
1400# light and dark mode via a button.
1401# The default value is: AUTO_LIGHT.
1402# This tag requires that the tag GENERATE_HTML is set to YES.
1403
1404HTML_COLORSTYLE = AUTO_LIGHT
1405
1406# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1407# will adjust the colors in the style sheet and background images according to
1408# this color. Hue is specified as an angle on a color-wheel, see
1409# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1410# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1411# purple, and 360 is red again.
1412# Minimum value: 0, maximum value: 359, default value: 220.
1413# This tag requires that the tag GENERATE_HTML is set to YES.
1414
1415HTML_COLORSTYLE_HUE = 220
1416
1417# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1418# in the HTML output. For a value of 0 the output will use gray-scales only. A
1419# value of 255 will produce the most vivid colors.
1420# Minimum value: 0, maximum value: 255, default value: 100.
1421# This tag requires that the tag GENERATE_HTML is set to YES.
1422
1423HTML_COLORSTYLE_SAT = 100
1424
1425# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1426# luminance component of the colors in the HTML output. Values below 100
1427# gradually make the output lighter, whereas values above 100 make the output
1428# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1429# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1430# change the gamma.
1431# Minimum value: 40, maximum value: 240, default value: 80.
1432# This tag requires that the tag GENERATE_HTML is set to YES.
1433
1434HTML_COLORSTYLE_GAMMA = 80
1435
1436# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1437# documentation will contain a main index with vertical navigation menus that
1438# are dynamically created via JavaScript. If disabled, the navigation index will
1439# consists of multiple levels of tabs that are statically embedded in every HTML
1440# page. Disable this option to support browsers that do not have JavaScript,
1441# like the Qt help browser.
1442# The default value is: YES.
1443# This tag requires that the tag GENERATE_HTML is set to YES.
1444
1445HTML_DYNAMIC_MENUS = YES
1446
1447# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1448# documentation will contain sections that can be hidden and shown after the
1449# page has loaded.
1450# The default value is: NO.
1451# This tag requires that the tag GENERATE_HTML is set to YES.
1452
1453HTML_DYNAMIC_SECTIONS = YES
1454
1455# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
1456# dynamically folded and expanded in the generated HTML source code.
1457# The default value is: YES.
1458# This tag requires that the tag GENERATE_HTML is set to YES.
1459
1460HTML_CODE_FOLDING = YES
1461
1462# If the HTML_COPY_CLIPBOARD tag is set to YES then doxygen will show an icon in
1463# the top right corner of code and text fragments that allows the user to copy
1464# its content to the clipboard. Note this only works if supported by the browser
1465# and the web page is served via a secure context (see:
1466# https://www.w3.org/TR/secure-contexts/), i.e. using the https: or file:
1467# protocol.
1468# The default value is: YES.
1469# This tag requires that the tag GENERATE_HTML is set to YES.
1470
1471HTML_COPY_CLIPBOARD = YES
1472
1473# Doxygen stores a couple of settings persistently in the browser (via e.g.
1474# cookies). By default these settings apply to all HTML pages generated by
1475# doxygen across all projects. The HTML_PROJECT_COOKIE tag can be used to store
1476# the settings under a project specific key, such that the user preferences will
1477# be stored separately.
1478# This tag requires that the tag GENERATE_HTML is set to YES.
1479
1480HTML_PROJECT_COOKIE =
1481
1482# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1483# shown in the various tree structured indices initially; the user can expand
1484# and collapse entries dynamically later on. Doxygen will expand the tree to
1485# such a level that at most the specified number of entries are visible (unless
1486# a fully collapsed tree already exceeds this amount). So setting the number of
1487# entries 1 will produce a full collapsed tree by default. 0 is a special value
1488# representing an infinite number of entries and will result in a full expanded
1489# tree by default.
1490# Minimum value: 0, maximum value: 9999, default value: 100.
1491# This tag requires that the tag GENERATE_HTML is set to YES.
1492
1493HTML_INDEX_NUM_ENTRIES = 100
1494
1495# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1496# generated that can be used as input for Apple's Xcode 3 integrated development
1497# environment (see:
1498# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1499# create a documentation set, doxygen will generate a Makefile in the HTML
1500# output directory. Running make will produce the docset in that directory and
1501# running make install will install the docset in
1502# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1503# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1504# genXcode/_index.html for more information.
1505# The default value is: NO.
1506# This tag requires that the tag GENERATE_HTML is set to YES.
1507
1508GENERATE_DOCSET = NO
1509
1510# This tag determines the name of the docset feed. A documentation feed provides
1511# an umbrella under which multiple documentation sets from a single provider
1512# (such as a company or product suite) can be grouped.
1513# The default value is: Doxygen generated docs.
1514# This tag requires that the tag GENERATE_DOCSET is set to YES.
1515
1516DOCSET_FEEDNAME = "Doxygen generated docs"
1517
1518# This tag determines the URL of the docset feed. A documentation feed provides
1519# an umbrella under which multiple documentation sets from a single provider
1520# (such as a company or product suite) can be grouped.
1521# This tag requires that the tag GENERATE_DOCSET is set to YES.
1522
1523DOCSET_FEEDURL =
1524
1525# This tag specifies a string that should uniquely identify the documentation
1526# set bundle. This should be a reverse domain-name style string, e.g.
1527# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1528# The default value is: org.doxygen.Project.
1529# This tag requires that the tag GENERATE_DOCSET is set to YES.
1530
1531DOCSET_BUNDLE_ID = org.doxygen.Project
1532
1533# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1534# the documentation publisher. This should be a reverse domain-name style
1535# string, e.g. com.mycompany.MyDocSet.documentation.
1536# The default value is: org.doxygen.Publisher.
1537# This tag requires that the tag GENERATE_DOCSET is set to YES.
1538
1539DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1540
1541# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1542# The default value is: Publisher.
1543# This tag requires that the tag GENERATE_DOCSET is set to YES.
1544
1545DOCSET_PUBLISHER_NAME = Publisher
1546
1547# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1548# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1549# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1550# on Windows. In the beginning of 2021 Microsoft took the original page, with
1551# a.o. the download links, offline the HTML help workshop was already many years
1552# in maintenance mode). You can download the HTML help workshop from the web
1553# archives at Installation executable (see:
1554# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
1555# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
1556#
1557# The HTML Help Workshop contains a compiler that can convert all HTML output
1558# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1559# files are now used as the Windows 98 help format, and will replace the old
1560# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1561# HTML files also contain an index, a table of contents, and you can search for
1562# words in the documentation. The HTML workshop also contains a viewer for
1563# compressed HTML files.
1564# The default value is: NO.
1565# This tag requires that the tag GENERATE_HTML is set to YES.
1566
1567GENERATE_HTMLHELP = NO
1568
1569# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1570# file. You can add a path in front of the file if the result should not be
1571# written to the html output directory.
1572# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1573
1574CHM_FILE =
1575
1576# The HHC_LOCATION tag can be used to specify the location (absolute path
1577# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1578# doxygen will try to run the HTML help compiler on the generated index.hhp.
1579# The file has to be specified with full path.
1580# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1581
1582HHC_LOCATION =
1583
1584# The GENERATE_CHI flag controls if a separate .chi index file is generated
1585# (YES) or that it should be included in the main .chm file (NO).
1586# The default value is: NO.
1587# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1588
1589GENERATE_CHI = NO
1590
1591# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1592# and project file content.
1593# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1594
1595CHM_INDEX_ENCODING =
1596
1597# The BINARY_TOC flag controls whether a binary table of contents is generated
1598# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1599# enables the Previous and Next buttons.
1600# The default value is: NO.
1601# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1602
1603BINARY_TOC = NO
1604
1605# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1606# the table of contents of the HTML help documentation and to the tree view.
1607# The default value is: NO.
1608# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1609
1610TOC_EXPAND = NO
1611
1612# The SITEMAP_URL tag is used to specify the full URL of the place where the
1613# generated documentation will be placed on the server by the user during the
1614# deployment of the documentation. The generated sitemap is called sitemap.xml
1615# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
1616# is specified no sitemap is generated. For information about the sitemap
1617# protocol see https://www.sitemaps.org
1618# This tag requires that the tag GENERATE_HTML is set to YES.
1619
1620SITEMAP_URL =
1621
1622# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1623# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1624# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1625# (.qch) of the generated HTML documentation.
1626# The default value is: NO.
1627# This tag requires that the tag GENERATE_HTML is set to YES.
1628
1629GENERATE_QHP = NO
1630
1631# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1632# the file name of the resulting .qch file. The path specified is relative to
1633# the HTML output folder.
1634# This tag requires that the tag GENERATE_QHP is set to YES.
1635
1636QCH_FILE =
1637
1638# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1639# Project output. For more information please see Qt Help Project / Namespace
1640# (see:
1641# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1642# The default value is: org.doxygen.Project.
1643# This tag requires that the tag GENERATE_QHP is set to YES.
1644
1645QHP_NAMESPACE = org.doxygen.Project
1646
1647# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1648# Help Project output. For more information please see Qt Help Project / Virtual
1649# Folders (see:
1650# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1651# The default value is: doc.
1652# This tag requires that the tag GENERATE_QHP is set to YES.
1653
1654QHP_VIRTUAL_FOLDER = doc
1655
1656# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1657# filter to add. For more information please see Qt Help Project / Custom
1658# Filters (see:
1659# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1660# This tag requires that the tag GENERATE_QHP is set to YES.
1661
1662QHP_CUST_FILTER_NAME =
1663
1664# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1665# custom filter to add. For more information please see Qt Help Project / Custom
1666# Filters (see:
1667# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1668# This tag requires that the tag GENERATE_QHP is set to YES.
1669
1670QHP_CUST_FILTER_ATTRS =
1671
1672# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1673# project's filter section matches. Qt Help Project / Filter Attributes (see:
1674# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1675# This tag requires that the tag GENERATE_QHP is set to YES.
1676
1677QHP_SECT_FILTER_ATTRS =
1678
1679# The QHG_LOCATION tag can be used to specify the location (absolute path
1680# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1681# run qhelpgenerator on the generated .qhp file.
1682# This tag requires that the tag GENERATE_QHP is set to YES.
1683
1684QHG_LOCATION =
1685
1686# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1687# generated, together with the HTML files, they form an Eclipse help plugin. To
1688# install this plugin and make it available under the help contents menu in
1689# Eclipse, the contents of the directory containing the HTML and XML files needs
1690# to be copied into the plugins directory of eclipse. The name of the directory
1691# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1692# After copying Eclipse needs to be restarted before the help appears.
1693# The default value is: NO.
1694# This tag requires that the tag GENERATE_HTML is set to YES.
1695
1696GENERATE_ECLIPSEHELP = NO
1697
1698# A unique identifier for the Eclipse help plugin. When installing the plugin
1699# the directory name containing the HTML and XML files should also have this
1700# name. Each documentation set should have its own identifier.
1701# The default value is: org.doxygen.Project.
1702# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1703
1704ECLIPSE_DOC_ID = org.doxygen.Project
1705
1706# If you want full control over the layout of the generated HTML pages it might
1707# be necessary to disable the index and replace it with your own. The
1708# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1709# of each HTML page. A value of NO enables the index and the value YES disables
1710# it. Since the tabs in the index contain the same information as the navigation
1711# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1712# The default value is: NO.
1713# This tag requires that the tag GENERATE_HTML is set to YES.
1714
1715DISABLE_INDEX = YES
1716
1717# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1718# structure should be generated to display hierarchical information. If the tag
1719# value is set to YES, a side panel will be generated containing a tree-like
1720# index structure (just like the one that is generated for HTML Help). For this
1721# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1722# (i.e. any modern browser). Windows users are probably better off using the
1723# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1724# further fine tune the look of the index (see "Fine-tuning the output"). As an
1725# example, the default style sheet generated by doxygen has an example that
1726# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
1727# Since the tree basically has the same information as the tab index, you could
1728# consider setting DISABLE_INDEX to YES when enabling this option.
1729# The default value is: NO.
1730# This tag requires that the tag GENERATE_HTML is set to YES.
1731
1732GENERATE_TREEVIEW = YES
1733
1734# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
1735# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
1736# area (value NO) or if it should extend to the full height of the window (value
1737# YES). Setting this to YES gives a layout similar to
1738# https://docs.readthedocs.io with more room for contents, but less room for the
1739# project logo, title, and description. If either GENERATE_TREEVIEW or
1740# DISABLE_INDEX is set to NO, this option has no effect.
1741# The default value is: NO.
1742# This tag requires that the tag GENERATE_HTML is set to YES.
1743
1744FULL_SIDEBAR = NO
1745
1746# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1747# doxygen will group on one line in the generated HTML documentation.
1748#
1749# Note that a value of 0 will completely suppress the enum values from appearing
1750# in the overview section.
1751# Minimum value: 0, maximum value: 20, default value: 4.
1752# This tag requires that the tag GENERATE_HTML is set to YES.
1753
1754ENUM_VALUES_PER_LINE = 1
1755
1756# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1757# to set the initial width (in pixels) of the frame in which the tree is shown.
1758# Minimum value: 0, maximum value: 1500, default value: 250.
1759# This tag requires that the tag GENERATE_HTML is set to YES.
1760
1761TREEVIEW_WIDTH = 250
1762
1763# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1764# external symbols imported via tag files in a separate window.
1765# The default value is: NO.
1766# This tag requires that the tag GENERATE_HTML is set to YES.
1767
1768EXT_LINKS_IN_WINDOW = NO
1769
1770# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
1771# addresses.
1772# The default value is: YES.
1773# This tag requires that the tag GENERATE_HTML is set to YES.
1774
1775OBFUSCATE_EMAILS = YES
1776
1777# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1778# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1779# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1780# the HTML output. These images will generally look nicer at scaled resolutions.
1781# Possible values are: png (the default) and svg (looks nicer but requires the
1782# pdf2svg or inkscape tool).
1783# The default value is: png.
1784# This tag requires that the tag GENERATE_HTML is set to YES.
1785
1786HTML_FORMULA_FORMAT = png
1787
1788# Use this tag to change the font size of LaTeX formulas included as images in
1789# the HTML documentation. When you change the font size after a successful
1790# doxygen run you need to manually remove any form_*.png images from the HTML
1791# output directory to force them to be regenerated.
1792# Minimum value: 8, maximum value: 50, default value: 10.
1793# This tag requires that the tag GENERATE_HTML is set to YES.
1794
1795FORMULA_FONTSIZE = 12
1796
1797# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1798# to create new LaTeX commands to be used in formulas as building blocks. See
1799# the section "Including formulas" for details.
1800
1801FORMULA_MACROFILE =
1802
1803# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1804# https://www.mathjax.org) which uses client side JavaScript for the rendering
1805# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1806# installed or if you want to formulas look prettier in the HTML output. When
1807# enabled you may also need to install MathJax separately and configure the path
1808# to it using the MATHJAX_RELPATH option.
1809# The default value is: NO.
1810# This tag requires that the tag GENERATE_HTML is set to YES.
1811
1812USE_MATHJAX = YES
1813
1814# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
1815# Note that the different versions of MathJax have different requirements with
1816# regards to the different settings, so it is possible that also other MathJax
1817# settings have to be changed when switching between the different MathJax
1818# versions.
1819# Possible values are: MathJax_2 and MathJax_3.
1820# The default value is: MathJax_2.
1821# This tag requires that the tag USE_MATHJAX is set to YES.
1822
1823MATHJAX_VERSION = MathJax_2
1824
1825# When MathJax is enabled you can set the default output format to be used for
1826# the MathJax output. For more details about the output format see MathJax
1827# version 2 (see:
1828# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
1829# (see:
1830# http://docs.mathjax.org/en/latest/web/components/output.html).
1831# Possible values are: HTML-CSS (which is slower, but has the best
1832# compatibility. This is the name for Mathjax version 2, for MathJax version 3
1833# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
1834# for MathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
1835# is the name for Mathjax version 3, for MathJax version 2 this will be
1836# translated into HTML-CSS) and SVG.
1837# The default value is: HTML-CSS.
1838# This tag requires that the tag USE_MATHJAX is set to YES.
1839
1840MATHJAX_FORMAT = HTML-CSS
1841
1842# When MathJax is enabled you need to specify the location relative to the HTML
1843# output directory using the MATHJAX_RELPATH option. The destination directory
1844# should contain the MathJax.js script. For instance, if the mathjax directory
1845# is located at the same level as the HTML output directory, then
1846# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1847# Content Delivery Network so you can quickly see the result without installing
1848# MathJax. However, it is strongly recommended to install a local copy of
1849# MathJax from https://www.mathjax.org before deployment. The default value is:
1850# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
1851# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
1852# This tag requires that the tag USE_MATHJAX is set to YES.
1853
1854MATHJAX_RELPATH = https://cdn.mathjax.org/mathjax/latest
1855
1856# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1857# extension names that should be enabled during MathJax rendering. For example
1858# for MathJax version 2 (see
1859# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
1860# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1861# For example for MathJax version 3 (see
1862# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
1863# MATHJAX_EXTENSIONS = ams
1864# This tag requires that the tag USE_MATHJAX is set to YES.
1865
1866MATHJAX_EXTENSIONS = TeX/AMSmath \
1867 TeX/AMSsymbols
1868
1869# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1870# of code that will be used on startup of the MathJax code. See the MathJax site
1871# (see:
1872# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1873# example see the documentation.
1874# This tag requires that the tag USE_MATHJAX is set to YES.
1875
1876MATHJAX_CODEFILE =
1877
1878# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1879# the HTML output. The underlying search engine uses javascript and DHTML and
1880# should work on any modern browser. Note that when using HTML help
1881# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1882# there is already a search function so this one should typically be disabled.
1883# For large projects the javascript based search engine can be slow, then
1884# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1885# search using the keyboard; to jump to the search box use <access key> + S
1886# (what the <access key> is depends on the OS and browser, but it is typically
1887# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1888# key> to jump into the search results window, the results can be navigated
1889# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1890# the search. The filter options can be selected when the cursor is inside the
1891# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1892# to select a filter and <Enter> or <escape> to activate or cancel the filter
1893# option.
1894# The default value is: YES.
1895# This tag requires that the tag GENERATE_HTML is set to YES.
1896
1897SEARCHENGINE = YES
1898
1899# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1900# implemented using a web server instead of a web client using JavaScript. There
1901# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1902# setting. When disabled, doxygen will generate a PHP script for searching and
1903# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1904# and searching needs to be provided by external tools. See the section
1905# "External Indexing and Searching" for details.
1906# The default value is: NO.
1907# This tag requires that the tag SEARCHENGINE is set to YES.
1908
1909SERVER_BASED_SEARCH = NO
1910
1911# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1912# script for searching. Instead the search results are written to an XML file
1913# which needs to be processed by an external indexer. Doxygen will invoke an
1914# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1915# search results.
1916#
1917# Doxygen ships with an example indexer (doxyindexer) and search engine
1918# (doxysearch.cgi) which are based on the open source search engine library
1919# Xapian (see:
1920# https://xapian.org/).
1921#
1922# See the section "External Indexing and Searching" for details.
1923# The default value is: NO.
1924# This tag requires that the tag SEARCHENGINE is set to YES.
1925
1926EXTERNAL_SEARCH = NO
1927
1928# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1929# which will return the search results when EXTERNAL_SEARCH is enabled.
1930#
1931# Doxygen ships with an example indexer (doxyindexer) and search engine
1932# (doxysearch.cgi) which are based on the open source search engine library
1933# Xapian (see:
1934# https://xapian.org/). See the section "External Indexing and Searching" for
1935# details.
1936# This tag requires that the tag SEARCHENGINE is set to YES.
1937
1938SEARCHENGINE_URL =
1939
1940# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1941# search data is written to a file for indexing by an external tool. With the
1942# SEARCHDATA_FILE tag the name of this file can be specified.
1943# The default file is: searchdata.xml.
1944# This tag requires that the tag SEARCHENGINE is set to YES.
1945
1946SEARCHDATA_FILE = searchdata.xml
1947
1948# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1949# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1950# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1951# projects and redirect the results back to the right project.
1952# This tag requires that the tag SEARCHENGINE is set to YES.
1953
1954EXTERNAL_SEARCH_ID =
1955
1956# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1957# projects other than the one defined by this configuration file, but that are
1958# all added to the same external search index. Each project needs to have a
1959# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1960# to a relative location where the documentation can be found. The format is:
1961# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1962# This tag requires that the tag SEARCHENGINE is set to YES.
1963
1964EXTRA_SEARCH_MAPPINGS =
1965
1966#---------------------------------------------------------------------------
1967# Configuration options related to the LaTeX output
1968#---------------------------------------------------------------------------
1969
1970# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1971# The default value is: YES.
1972
1973GENERATE_LATEX = NO
1974
1975# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1976# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1977# it.
1978# The default directory is: latex.
1979# This tag requires that the tag GENERATE_LATEX is set to YES.
1980
1981LATEX_OUTPUT = latex
1982
1983# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1984# invoked.
1985#
1986# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1987# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1988# chosen this is overwritten by pdflatex. For specific output languages the
1989# default can have been set differently, this depends on the implementation of
1990# the output language.
1991# This tag requires that the tag GENERATE_LATEX is set to YES.
1992
1993LATEX_CMD_NAME = latex
1994
1995# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1996# index for LaTeX.
1997# Note: This tag is used in the Makefile / make.bat.
1998# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1999# (.tex).
2000# The default file is: makeindex.
2001# This tag requires that the tag GENERATE_LATEX is set to YES.
2002
2003MAKEINDEX_CMD_NAME = makeindex
2004
2005# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
2006# generate index for LaTeX. In case there is no backslash (\‍) as first character
2007# it will be automatically added in the LaTeX code.
2008# Note: This tag is used in the generated output file (.tex).
2009# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
2010# The default value is: makeindex.
2011# This tag requires that the tag GENERATE_LATEX is set to YES.
2012
2013LATEX_MAKEINDEX_CMD = makeindex
2014
2015# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
2016# documents. This may be useful for small projects and may help to save some
2017# trees in general.
2018# The default value is: NO.
2019# This tag requires that the tag GENERATE_LATEX is set to YES.
2020
2021COMPACT_LATEX = NO
2022
2023# The PAPER_TYPE tag can be used to set the paper type that is used by the
2024# printer.
2025# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
2026# 14 inches) and executive (7.25 x 10.5 inches).
2027# The default value is: a4.
2028# This tag requires that the tag GENERATE_LATEX is set to YES.
2029
2030PAPER_TYPE = a4wide
2031
2032# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
2033# that should be included in the LaTeX output. The package can be specified just
2034# by its name or with the correct syntax as to be used with the LaTeX
2035# \usepackage command. To get the times font for instance you can specify :
2036# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
2037# To use the option intlimits with the amsmath package you can specify:
2038# EXTRA_PACKAGES=[intlimits]{amsmath}
2039# If left blank no extra packages will be included.
2040# This tag requires that the tag GENERATE_LATEX is set to YES.
2041
2042EXTRA_PACKAGES = amssymb \
2043 amsmath
2044
2045# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
2046# the generated LaTeX document. The header should contain everything until the
2047# first chapter. If it is left blank doxygen will generate a standard header. It
2048# is highly recommended to start with a default header using
2049# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
2050# and then modify the file new_header.tex. See also section "Doxygen usage" for
2051# information on how to generate the default header that doxygen normally uses.
2052#
2053# Note: Only use a user-defined header if you know what you are doing!
2054# Note: The header is subject to change so you typically have to regenerate the
2055# default header when upgrading to a newer version of doxygen. The following
2056# commands have a special meaning inside the header (and footer): For a
2057# description of the possible markers and block names see the documentation.
2058# This tag requires that the tag GENERATE_LATEX is set to YES.
2059
2060LATEX_HEADER =
2061
2062# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
2063# the generated LaTeX document. The footer should contain everything after the
2064# last chapter. If it is left blank doxygen will generate a standard footer. See
2065# LATEX_HEADER for more information on how to generate a default footer and what
2066# special commands can be used inside the footer. See also section "Doxygen
2067# usage" for information on how to generate the default footer that doxygen
2068# normally uses. Note: Only use a user-defined footer if you know what you are
2069# doing!
2070# This tag requires that the tag GENERATE_LATEX is set to YES.
2071
2072LATEX_FOOTER =
2073
2074# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
2075# LaTeX style sheets that are included after the standard style sheets created
2076# by doxygen. Using this option one can overrule certain style aspects. Doxygen
2077# will copy the style sheet files to the output directory.
2078# Note: The order of the extra style sheet files is of importance (e.g. the last
2079# style sheet in the list overrules the setting of the previous ones in the
2080# list).
2081# This tag requires that the tag GENERATE_LATEX is set to YES.
2082
2083LATEX_EXTRA_STYLESHEET =
2084
2085# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
2086# other source files which should be copied to the LATEX_OUTPUT output
2087# directory. Note that the files will be copied as-is; there are no commands or
2088# markers available.
2089# This tag requires that the tag GENERATE_LATEX is set to YES.
2090
2091LATEX_EXTRA_FILES =
2092
2093# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
2094# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
2095# contain links (just like the HTML output) instead of page references. This
2096# makes the output suitable for online browsing using a PDF viewer.
2097# The default value is: YES.
2098# This tag requires that the tag GENERATE_LATEX is set to YES.
2099
2100PDF_HYPERLINKS = NO
2101
2102# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
2103# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
2104# files. Set this option to YES, to get a higher quality PDF documentation.
2105#
2106# See also section LATEX_CMD_NAME for selecting the engine.
2107# The default value is: YES.
2108# This tag requires that the tag GENERATE_LATEX is set to YES.
2109
2110USE_PDFLATEX = NO
2111
2112# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
2113# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
2114# mode nothing is printed on the terminal, errors are scrolled as if <return> is
2115# hit at every error; missing files that TeX tries to input or request from
2116# keyboard input (\read on a not open input stream) cause the job to abort,
2117# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
2118# but there is no possibility of user interaction just like in batch mode,
2119# SCROLL In scroll mode, TeX will stop only for missing files to input or if
2120# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
2121# each error, asking for user intervention.
2122# The default value is: NO.
2123# This tag requires that the tag GENERATE_LATEX is set to YES.
2124
2125LATEX_BATCHMODE = NO
2126
2127# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
2128# index chapters (such as File Index, Compound Index, etc.) in the output.
2129# The default value is: NO.
2130# This tag requires that the tag GENERATE_LATEX is set to YES.
2131
2132LATEX_HIDE_INDICES = NO
2133
2134# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
2135# bibliography, e.g. plainnat, or ieeetr. See
2136# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
2137# The default value is: plain.
2138# This tag requires that the tag GENERATE_LATEX is set to YES.
2139
2140LATEX_BIB_STYLE = plain
2141
2142# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
2143# path from which the emoji images will be read. If a relative path is entered,
2144# it will be relative to the LATEX_OUTPUT directory. If left blank the
2145# LATEX_OUTPUT directory will be used.
2146# This tag requires that the tag GENERATE_LATEX is set to YES.
2147
2148LATEX_EMOJI_DIRECTORY =
2149
2150#---------------------------------------------------------------------------
2151# Configuration options related to the RTF output
2152#---------------------------------------------------------------------------
2153
2154# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
2155# RTF output is optimized for Word 97 and may not look too pretty with other RTF
2156# readers/editors.
2157# The default value is: NO.
2158
2159GENERATE_RTF = NO
2160
2161# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
2162# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2163# it.
2164# The default directory is: rtf.
2165# This tag requires that the tag GENERATE_RTF is set to YES.
2166
2167RTF_OUTPUT = rtf
2168
2169# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
2170# documents. This may be useful for small projects and may help to save some
2171# trees in general.
2172# The default value is: NO.
2173# This tag requires that the tag GENERATE_RTF is set to YES.
2174
2175COMPACT_RTF = NO
2176
2177# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
2178# contain hyperlink fields. The RTF file will contain links (just like the HTML
2179# output) instead of page references. This makes the output suitable for online
2180# browsing using Word or some other Word compatible readers that support those
2181# fields.
2182#
2183# Note: WordPad (write) and others do not support links.
2184# The default value is: NO.
2185# This tag requires that the tag GENERATE_RTF is set to YES.
2186
2187RTF_HYPERLINKS = NO
2188
2189# Load stylesheet definitions from file. Syntax is similar to doxygen's
2190# configuration file, i.e. a series of assignments. You only have to provide
2191# replacements, missing definitions are set to their default value.
2192#
2193# See also section "Doxygen usage" for information on how to generate the
2194# default style sheet that doxygen normally uses.
2195# This tag requires that the tag GENERATE_RTF is set to YES.
2196
2197RTF_STYLESHEET_FILE =
2198
2199# Set optional variables used in the generation of an RTF document. Syntax is
2200# similar to doxygen's configuration file. A template extensions file can be
2201# generated using doxygen -e rtf extensionFile.
2202# This tag requires that the tag GENERATE_RTF is set to YES.
2203
2204RTF_EXTENSIONS_FILE =
2205
2206# The RTF_EXTRA_FILES tag can be used to specify one or more extra images or
2207# other source files which should be copied to the RTF_OUTPUT output directory.
2208# Note that the files will be copied as-is; there are no commands or markers
2209# available.
2210# This tag requires that the tag GENERATE_RTF is set to YES.
2211
2212RTF_EXTRA_FILES =
2213
2214#---------------------------------------------------------------------------
2215# Configuration options related to the man page output
2216#---------------------------------------------------------------------------
2217
2218# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2219# classes and files.
2220# The default value is: NO.
2221
2222GENERATE_MAN = NO
2223
2224# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2225# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2226# it. A directory man3 will be created inside the directory specified by
2227# MAN_OUTPUT.
2228# The default directory is: man.
2229# This tag requires that the tag GENERATE_MAN is set to YES.
2230
2231MAN_OUTPUT = man
2232
2233# The MAN_EXTENSION tag determines the extension that is added to the generated
2234# man pages. In case the manual section does not start with a number, the number
2235# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2236# optional.
2237# The default value is: .3.
2238# This tag requires that the tag GENERATE_MAN is set to YES.
2239
2240MAN_EXTENSION = .3
2241
2242# The MAN_SUBDIR tag determines the name of the directory created within
2243# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2244# MAN_EXTENSION with the initial . removed.
2245# This tag requires that the tag GENERATE_MAN is set to YES.
2246
2247MAN_SUBDIR =
2248
2249# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2250# will generate one additional man file for each entity documented in the real
2251# man page(s). These additional files only source the real man page, but without
2252# them the man command would be unable to find the correct page.
2253# The default value is: NO.
2254# This tag requires that the tag GENERATE_MAN is set to YES.
2255
2256MAN_LINKS = NO
2257
2258#---------------------------------------------------------------------------
2259# Configuration options related to the XML output
2260#---------------------------------------------------------------------------
2261
2262# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2263# captures the structure of the code including all documentation.
2264# The default value is: NO.
2265
2266GENERATE_XML = NO
2267
2268# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2269# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2270# it.
2271# The default directory is: xml.
2272# This tag requires that the tag GENERATE_XML is set to YES.
2273
2274XML_OUTPUT = xml
2275
2276# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2277# listings (including syntax highlighting and cross-referencing information) to
2278# the XML output. Note that enabling this will significantly increase the size
2279# of the XML output.
2280# The default value is: YES.
2281# This tag requires that the tag GENERATE_XML is set to YES.
2282
2283XML_PROGRAMLISTING = YES
2284
2285# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2286# namespace members in file scope as well, matching the HTML output.
2287# The default value is: NO.
2288# This tag requires that the tag GENERATE_XML is set to YES.
2289
2290XML_NS_MEMB_FILE_SCOPE = NO
2291
2292#---------------------------------------------------------------------------
2293# Configuration options related to the DOCBOOK output
2294#---------------------------------------------------------------------------
2295
2296# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2297# that can be used to generate PDF.
2298# The default value is: NO.
2299
2300GENERATE_DOCBOOK = NO
2301
2302# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2303# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2304# front of it.
2305# The default directory is: docbook.
2306# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2307
2308DOCBOOK_OUTPUT = docbook
2309
2310#---------------------------------------------------------------------------
2311# Configuration options for the AutoGen Definitions output
2312#---------------------------------------------------------------------------
2313
2314# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2315# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
2316# the structure of the code including all documentation. Note that this feature
2317# is still experimental and incomplete at the moment.
2318# The default value is: NO.
2319
2320GENERATE_AUTOGEN_DEF = NO
2321
2322#---------------------------------------------------------------------------
2323# Configuration options related to Sqlite3 output
2324#---------------------------------------------------------------------------
2325
2326# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
2327# database with symbols found by doxygen stored in tables.
2328# The default value is: NO.
2329
2330GENERATE_SQLITE3 = NO
2331
2332# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database will be
2333# put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put
2334# in front of it.
2335# The default directory is: sqlite3.
2336# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2337
2338SQLITE3_OUTPUT = sqlite3
2339
2340# The SQLITE3_RECREATE_DB tag is set to YES, the existing doxygen_sqlite3.db
2341# database file will be recreated with each doxygen run. If set to NO, doxygen
2342# will warn if a database file is already found and not modify it.
2343# The default value is: YES.
2344# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
2345
2346SQLITE3_RECREATE_DB = YES
2347
2348#---------------------------------------------------------------------------
2349# Configuration options related to the Perl module output
2350#---------------------------------------------------------------------------
2351
2352# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2353# file that captures the structure of the code including all documentation.
2354#
2355# Note that this feature is still experimental and incomplete at the moment.
2356# The default value is: NO.
2357
2358GENERATE_PERLMOD = NO
2359
2360# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2361# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2362# output from the Perl module output.
2363# The default value is: NO.
2364# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2365
2366PERLMOD_LATEX = NO
2367
2368# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2369# formatted so it can be parsed by a human reader. This is useful if you want to
2370# understand what is going on. On the other hand, if this tag is set to NO, the
2371# size of the Perl module output will be much smaller and Perl will parse it
2372# just the same.
2373# The default value is: YES.
2374# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2375
2376PERLMOD_PRETTY = YES
2377
2378# The names of the make variables in the generated doxyrules.make file are
2379# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2380# so different doxyrules.make files included by the same Makefile don't
2381# overwrite each other's variables.
2382# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2383
2384PERLMOD_MAKEVAR_PREFIX =
2385
2386#---------------------------------------------------------------------------
2387# Configuration options related to the preprocessor
2388#---------------------------------------------------------------------------
2389
2390# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2391# C-preprocessor directives found in the sources and include files.
2392# The default value is: YES.
2393
2394ENABLE_PREPROCESSING = YES
2395
2396# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2397# in the source code. If set to NO, only conditional compilation will be
2398# performed. Macro expansion can be done in a controlled way by setting
2399# EXPAND_ONLY_PREDEF to YES.
2400# The default value is: NO.
2401# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2402
2403MACRO_EXPANSION = YES
2404
2405# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2406# the macro expansion is limited to the macros specified with the PREDEFINED and
2407# EXPAND_AS_DEFINED tags.
2408# The default value is: NO.
2409# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2410
2411EXPAND_ONLY_PREDEF = YES
2412
2413# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2414# INCLUDE_PATH will be searched if a #include is found.
2415# The default value is: YES.
2416# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2417
2418SEARCH_INCLUDES = YES
2419
2420# The INCLUDE_PATH tag can be used to specify one or more directories that
2421# contain include files that are not input files but should be processed by the
2422# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
2423# RECURSIVE has no effect here.
2424# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2425
2426INCLUDE_PATH = "/Eigen/src/plugins"
2427
2428# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2429# patterns (like *.h and *.hpp) to filter out the header-files in the
2430# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2431# used.
2432# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2433
2434INCLUDE_FILE_PATTERNS =
2435
2436# The PREDEFINED tag can be used to specify one or more macro names that are
2437# defined before the preprocessor is started (similar to the -D option of e.g.
2438# gcc). The argument of the tag is a list of macros of the form: name or
2439# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2440# is assumed. To prevent a macro definition from being undefined via #undef or
2441# recursively expanded use the := operator instead of the = operator.
2442# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2443
2444PREDEFINED = EIGEN_EMPTY_STRUCT \
2445 EIGEN_PARSED_BY_DOXYGEN \
2446 EIGEN_VECTORIZE \
2447 EIGEN_QT_SUPPORT \
2448 EIGEN_STRONG_INLINE=inline \
2449 EIGEN_DEVICE_FUNC= \
2450 "EIGEN_MAKE_CWISE_BINARY_OP(METHOD,FUNCTOR)=template<typename OtherDerived> const CwiseBinaryOp<FUNCTOR<Scalar>, const Derived, const OtherDerived> METHOD(const EIGEN_CURRENT_STORAGE_BASE_CLASS<OtherDerived> &other) const;" \
2451 "EIGEN_CWISE_PRODUCT_RETURN_TYPE(LHS,RHS)=CwiseBinaryOp<internal::scalar_product_op<LHS::Scalar,RHS::Scalar>, const LHS, const RHS>" \
2452 "EIGEN_CAT2(a,b)= a ## b" \
2453 "EIGEN_CAT(a,b)=EIGEN_CAT2(a,b)" \
2454 "EIGEN_CWISE_BINARY_RETURN_TYPE(LHS,RHS,OPNAME)=CwiseBinaryOp<EIGEN_CAT(EIGEN_CAT(internal::scalar_,OPNAME),_op)<LHS::Scalar, RHS::Scalar>, const LHS, const RHS>" \
2455 "EIGEN_ALIGN_TO_BOUNDARY(x)=" \
2456 "DOXCOMMA=,"
2457
2458# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2459# tag can be used to specify a list of macro names that should be expanded. The
2460# macro definition that is found in the sources will be used. Use the PREDEFINED
2461# tag if you want to use a different macro definition that overrules the
2462# definition found in the source code.
2463# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2464
2465EXPAND_AS_DEFINED = EIGEN_MAKE_TYPEDEFS \
2466 EIGEN_MAKE_FIXED_TYPEDEFS \
2467 EIGEN_MAKE_TYPEDEFS_ALL_SIZES \
2468 EIGEN_MAKE_ARRAY_TYPEDEFS \
2469 EIGEN_MAKE_ARRAY_FIXED_TYPEDEFS \
2470 EIGEN_MAKE_ARRAY_TYPEDEFS_ALL_SIZES \
2471 EIGEN_CWISE_UNOP_RETURN_TYPE \
2472 EIGEN_CWISE_BINOP_RETURN_TYPE \
2473 EIGEN_CURRENT_STORAGE_BASE_CLASS \
2474 EIGEN_MATHFUNC_IMPL \
2475 _EIGEN_GENERIC_PUBLIC_INTERFACE \
2476 EIGEN_ARRAY_DECLARE_GLOBAL_UNARY \
2477 EIGEN_EMPTY \
2478 EIGEN_EULER_ANGLES_TYPEDEFS \
2479 EIGEN_EULER_ANGLES_SINGLE_TYPEDEF \
2480 EIGEN_EULER_SYSTEM_TYPEDEF \
2481 EIGEN_AUTODIFF_DECLARE_GLOBAL_UNARY \
2482 EIGEN_MATRIX_FUNCTION \
2483 EIGEN_MATRIX_FUNCTION_1 \
2484 EIGEN_DOC_UNARY_ADDONS \
2485 EIGEN_DOC_BLOCK_ADDONS_NOT_INNER_PANEL \
2486 EIGEN_DOC_BLOCK_ADDONS_INNER_PANEL_IF
2487
2488# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2489# remove all references to function-like macros that are alone on a line, have
2490# an all uppercase name, and do not end with a semicolon. Such function macros
2491# are typically used for boiler-plate code, and will confuse the parser if not
2492# removed.
2493# The default value is: YES.
2494# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2495
2496SKIP_FUNCTION_MACROS = YES
2497
2498#---------------------------------------------------------------------------
2499# Configuration options related to external references
2500#---------------------------------------------------------------------------
2501
2502# The TAGFILES tag can be used to specify one or more tag files. For each tag
2503# file the location of the external documentation should be added. The format of
2504# a tag file without this location is as follows:
2505# TAGFILES = file1 file2 ...
2506# Adding location for the tag files is done as follows:
2507# TAGFILES = file1=loc1 "file2 = loc2" ...
2508# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2509# section "Linking to external documentation" for more information about the use
2510# of tag files.
2511# Note: Each tag file must have a unique name (where the name does NOT include
2512# the path). If a tag file is not located in the directory in which doxygen is
2513# run, you must also specify the path to the tagfile here.
2514
2515TAGFILES =
2516
2517# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2518# tag file that is based on the input files it reads. See section "Linking to
2519# external documentation" for more information about the usage of tag files.
2520
2521GENERATE_TAGFILE = /doc/Eigen.doxytags
2522
2523# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
2524# will be listed in the class and namespace index. If set to NO, only the
2525# inherited external classes will be listed.
2526# The default value is: NO.
2527
2528ALLEXTERNALS = NO
2529
2530# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2531# in the topic index. If set to NO, only the current project's groups will be
2532# listed.
2533# The default value is: YES.
2534
2535EXTERNAL_GROUPS = NO
2536
2537# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2538# the related pages index. If set to NO, only the current project's pages will
2539# be listed.
2540# The default value is: YES.
2541
2542EXTERNAL_PAGES = YES
2543
2544#---------------------------------------------------------------------------
2545# Configuration options related to diagram generator tools
2546#---------------------------------------------------------------------------
2547
2548# If set to YES the inheritance and collaboration graphs will hide inheritance
2549# and usage relations if the target is undocumented or is not a class.
2550# The default value is: YES.
2551
2552HIDE_UNDOC_RELATIONS = NO
2553
2554# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2555# available from the path. This tool is part of Graphviz (see:
2556# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2557# Bell Labs. The other options in this section have no effect if this option is
2558# set to NO
2559# The default value is: NO.
2560
2561HAVE_DOT = YES
2562
2563# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2564# to run in parallel. When set to 0 doxygen will base this on the number of
2565# processors available in the system. You can set it explicitly to a value
2566# larger than 0 to get control over the balance between CPU load and processing
2567# speed.
2568# Minimum value: 0, maximum value: 32, default value: 0.
2569# This tag requires that the tag HAVE_DOT is set to YES.
2570
2571DOT_NUM_THREADS = 0
2572
2573# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
2574# subgraphs. When you want a differently looking font in the dot files that
2575# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
2576# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
2577# Edge and Graph Attributes specification</a> You need to make sure dot is able
2578# to find the font, which can be done by putting it in a standard location or by
2579# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
2580# directory containing the font. Default graphviz fontsize is 14.
2581# The default value is: fontname=Helvetica,fontsize=10.
2582# This tag requires that the tag HAVE_DOT is set to YES.
2583
2584DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
2585
2586# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
2587# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
2588# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
2589# arrows shapes.</a>
2590# The default value is: labelfontname=Helvetica,labelfontsize=10.
2591# This tag requires that the tag HAVE_DOT is set to YES.
2592
2593DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
2594
2595# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
2596# around nodes set 'shape=plain' or 'shape=plaintext' <a
2597# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
2598# The default value is: shape=box,height=0.2,width=0.4.
2599# This tag requires that the tag HAVE_DOT is set to YES.
2600
2601DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
2602
2603# You can set the path where dot can find font specified with fontname in
2604# DOT_COMMON_ATTR and others dot attributes.
2605# This tag requires that the tag HAVE_DOT is set to YES.
2606
2607DOT_FONTPATH =
2608
2609# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
2610# generate a graph for each documented class showing the direct and indirect
2611# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
2612# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
2613# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
2614# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
2615# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
2616# relations will be shown as texts / links. Explicit enabling an inheritance
2617# graph or choosing a different representation for an inheritance graph of a
2618# specific class, can be accomplished by means of the command \inheritancegraph.
2619# Disabling an inheritance graph can be accomplished by means of the command
2620# \hideinheritancegraph.
2621# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
2622# The default value is: YES.
2623
2624CLASS_GRAPH = YES
2625
2626# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2627# graph for each documented class showing the direct and indirect implementation
2628# dependencies (inheritance, containment, and class references variables) of the
2629# class with other documented classes. Explicit enabling a collaboration graph,
2630# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
2631# command \collaborationgraph. Disabling a collaboration graph can be
2632# accomplished by means of the command \hidecollaborationgraph.
2633# The default value is: YES.
2634# This tag requires that the tag HAVE_DOT is set to YES.
2635
2636COLLABORATION_GRAPH = NO
2637
2638# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2639# groups, showing the direct groups dependencies. Explicit enabling a group
2640# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
2641# of the command \groupgraph. Disabling a directory graph can be accomplished by
2642# means of the command \hidegroupgraph. See also the chapter Grouping in the
2643# manual.
2644# The default value is: YES.
2645# This tag requires that the tag HAVE_DOT is set to YES.
2646
2647GROUP_GRAPHS = NO
2648
2649# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2650# collaboration diagrams in a style similar to the OMG's Unified Modeling
2651# Language.
2652# The default value is: NO.
2653# This tag requires that the tag HAVE_DOT is set to YES.
2654
2655UML_LOOK = YES
2656
2657# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2658# class node. If there are many fields or methods and many nodes the graph may
2659# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2660# number of items for each type to make the size more manageable. Set this to 0
2661# for no limit. Note that the threshold may be exceeded by 50% before the limit
2662# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2663# but if the number exceeds 15, the total amount of fields shown is limited to
2664# 10.
2665# Minimum value: 0, maximum value: 100, default value: 10.
2666# This tag requires that the tag UML_LOOK is set to YES.
2667
2668UML_LIMIT_NUM_FIELDS = 10
2669
2670# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2671# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2672# tag is set to YES, doxygen will add type and arguments for attributes and
2673# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2674# will not generate fields with class member information in the UML graphs. The
2675# class diagrams will look similar to the default class diagrams but using UML
2676# notation for the relationships.
2677# Possible values are: NO, YES and NONE.
2678# The default value is: NO.
2679# This tag requires that the tag UML_LOOK is set to YES.
2680
2681DOT_UML_DETAILS = NO
2682
2683# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2684# to display on a single line. If the actual line length exceeds this threshold
2685# significantly it will be wrapped across multiple lines. Some heuristics are
2686# applied to avoid ugly line breaks.
2687# Minimum value: 0, maximum value: 1000, default value: 17.
2688# This tag requires that the tag HAVE_DOT is set to YES.
2689
2690DOT_WRAP_THRESHOLD = 17
2691
2692# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2693# collaboration graphs will show the relations between templates and their
2694# instances.
2695# The default value is: NO.
2696# This tag requires that the tag HAVE_DOT is set to YES.
2697
2698TEMPLATE_RELATIONS = NO
2699
2700# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2701# YES then doxygen will generate a graph for each documented file showing the
2702# direct and indirect include dependencies of the file with other documented
2703# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
2704# can be accomplished by means of the command \includegraph. Disabling an
2705# include graph can be accomplished by means of the command \hideincludegraph.
2706# The default value is: YES.
2707# This tag requires that the tag HAVE_DOT is set to YES.
2708
2709INCLUDE_GRAPH = NO
2710
2711# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2712# set to YES then doxygen will generate a graph for each documented file showing
2713# the direct and indirect include dependencies of the file with other documented
2714# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
2715# to NO, can be accomplished by means of the command \includedbygraph. Disabling
2716# an included by graph can be accomplished by means of the command
2717# \hideincludedbygraph.
2718# The default value is: YES.
2719# This tag requires that the tag HAVE_DOT is set to YES.
2720
2721INCLUDED_BY_GRAPH = NO
2722
2723# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2724# dependency graph for every global function or class method.
2725#
2726# Note that enabling this option will significantly increase the time of a run.
2727# So in most cases it will be better to enable call graphs for selected
2728# functions only using the \callgraph command. Disabling a call graph can be
2729# accomplished by means of the command \hidecallgraph.
2730# The default value is: NO.
2731# This tag requires that the tag HAVE_DOT is set to YES.
2732
2733CALL_GRAPH = NO
2734
2735# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2736# dependency graph for every global function or class method.
2737#
2738# Note that enabling this option will significantly increase the time of a run.
2739# So in most cases it will be better to enable caller graphs for selected
2740# functions only using the \callergraph command. Disabling a caller graph can be
2741# accomplished by means of the command \hidecallergraph.
2742# The default value is: NO.
2743# This tag requires that the tag HAVE_DOT is set to YES.
2744
2745CALLER_GRAPH = NO
2746
2747# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2748# hierarchy of all classes instead of a textual one.
2749# The default value is: YES.
2750# This tag requires that the tag HAVE_DOT is set to YES.
2751
2752GRAPHICAL_HIERARCHY = NO
2753
2754# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2755# dependencies a directory has on other directories in a graphical way. The
2756# dependency relations are determined by the #include relations between the
2757# files in the directories. Explicit enabling a directory graph, when
2758# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
2759# \directorygraph. Disabling a directory graph can be accomplished by means of
2760# the command \hidedirectorygraph.
2761# The default value is: YES.
2762# This tag requires that the tag HAVE_DOT is set to YES.
2763
2764DIRECTORY_GRAPH = NO
2765
2766# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
2767# of child directories generated in directory dependency graphs by dot.
2768# Minimum value: 1, maximum value: 25, default value: 1.
2769# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
2770
2771DIR_GRAPH_MAX_DEPTH = 1
2772
2773# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2774# generated by dot. For an explanation of the image formats see the section
2775# output formats in the documentation of the dot tool (Graphviz (see:
2776# https://www.graphviz.org/)).
2777# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2778# to make the SVG files visible in IE 9+ (other browsers do not have this
2779# requirement).
2780# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2781# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2782# png:gdiplus:gdiplus.
2783# The default value is: png.
2784# This tag requires that the tag HAVE_DOT is set to YES.
2785
2786DOT_IMAGE_FORMAT = png
2787
2788# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2789# enable generation of interactive SVG images that allow zooming and panning.
2790#
2791# Note that this requires a modern browser other than Internet Explorer. Tested
2792# and working are Firefox, Chrome, Safari, and Opera.
2793# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2794# the SVG files visible. Older versions of IE do not have SVG support.
2795# The default value is: NO.
2796# This tag requires that the tag HAVE_DOT is set to YES.
2797
2798INTERACTIVE_SVG = NO
2799
2800# The DOT_PATH tag can be used to specify the path where the dot tool can be
2801# found. If left blank, it is assumed the dot tool can be found in the path.
2802# This tag requires that the tag HAVE_DOT is set to YES.
2803
2804DOT_PATH =
2805
2806# The DOTFILE_DIRS tag can be used to specify one or more directories that
2807# contain dot files that are included in the documentation (see the \dotfile
2808# command).
2809# This tag requires that the tag HAVE_DOT is set to YES.
2810
2811DOTFILE_DIRS =
2812
2813# You can include diagrams made with dia in doxygen documentation. Doxygen will
2814# then run dia to produce the diagram and insert it in the documentation. The
2815# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2816# If left empty dia is assumed to be found in the default search path.
2817
2818DIA_PATH =
2819
2820# The DIAFILE_DIRS tag can be used to specify one or more directories that
2821# contain dia files that are included in the documentation (see the \diafile
2822# command).
2823
2824DIAFILE_DIRS =
2825
2826# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2827# path where java can find the plantuml.jar file or to the filename of jar file
2828# to be used. If left blank, it is assumed PlantUML is not used or called during
2829# a preprocessing step. Doxygen will generate a warning when it encounters a
2830# \startuml command in this case and will not generate output for the diagram.
2831
2832PLANTUML_JAR_PATH =
2833
2834# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2835# configuration file for plantuml.
2836
2837PLANTUML_CFG_FILE =
2838
2839# When using plantuml, the specified paths are searched for files specified by
2840# the !include statement in a plantuml block.
2841
2842PLANTUML_INCLUDE_PATH =
2843
2844# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2845# that will be shown in the graph. If the number of nodes in a graph becomes
2846# larger than this value, doxygen will truncate the graph, which is visualized
2847# by representing a node as a red box. Note that if the number of direct
2848# children of the root node in a graph is already larger than
2849# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2850# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2851# Minimum value: 0, maximum value: 10000, default value: 50.
2852# This tag requires that the tag HAVE_DOT is set to YES.
2853
2854DOT_GRAPH_MAX_NODES = 50
2855
2856# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2857# generated by dot. A depth value of 3 means that only nodes reachable from the
2858# root by following a path via at most 3 edges will be shown. Nodes that lay
2859# further from the root node will be omitted. Note that setting this option to 1
2860# or 2 may greatly reduce the computation time needed for large code bases. Also
2861# note that the size of a graph can be further restricted by
2862# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2863# Minimum value: 0, maximum value: 1000, default value: 0.
2864# This tag requires that the tag HAVE_DOT is set to YES.
2865
2866MAX_DOT_GRAPH_DEPTH = 0
2867
2868# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2869# files in one run (i.e. multiple -o and -T options on the command line). This
2870# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2871# this, this feature is disabled by default.
2872# The default value is: NO.
2873# This tag requires that the tag HAVE_DOT is set to YES.
2874
2875DOT_MULTI_TARGETS = NO
2876
2877# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2878# explaining the meaning of the various boxes and arrows in the dot generated
2879# graphs.
2880# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
2881# graphical representation for inheritance and collaboration diagrams is used.
2882# The default value is: YES.
2883# This tag requires that the tag HAVE_DOT is set to YES.
2884
2885GENERATE_LEGEND = YES
2886
2887# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2888# files that are used to generate the various graphs.
2889#
2890# Note: This setting is not only used for dot files but also for msc temporary
2891# files.
2892# The default value is: YES.
2893
2894DOT_CLEANUP = YES
2895
2896# You can define message sequence charts within doxygen comments using the \msc
2897# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
2898# use a built-in version of mscgen tool to produce the charts. Alternatively,
2899# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
2900# specifying prog as the value, doxygen will call the tool as prog -T
2901# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
2902# output file formats "png", "eps", "svg", and "ismap".
2903
2904MSCGEN_TOOL =
2905
2906# The MSCFILE_DIRS tag can be used to specify one or more directories that
2907# contain msc files that are included in the documentation (see the \mscfile
2908# command).
2909
2910MSCFILE_DIRS =