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