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