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