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