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