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