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