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