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