blob: 66fad8275ef265ab87df480724949c81b5150919 [file] [log] [blame]
Joe Gregoriodd51aac2019-03-07 14:11:52 -05001# 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
Joe Gregorioca9e2a42019-03-11 11:14:12 -0400444EXTRACT_PRIVATE = NO
Joe Gregoriodd51aac2019-03-07 14:11:52 -0500445
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
Joe Gregorioc6611c02019-06-03 09:09:07 -0400793INPUT = ../../include/core \
794 ../../include/effects \
Hal Canary051f7d62019-10-18 14:31:22 -0400795 ../../include/docs \
Joe Gregorioc6611c02019-06-03 09:09:07 -0400796 ../../include/gpu \
797 ../../include/pathops \
798 ../../third_party/skcms \
799 ../../modules/particles/include \
800 ../../modules/skottie/include \
801 ../../modules/sksg/include \
802 ../../modules/skshaper/include \
803 ./mainpage
Joe Gregoriodd51aac2019-03-07 14:11:52 -0500804
805# This tag can be used to specify the character encoding of the source files
806# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
807# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
808# documentation (see: http://www.gnu.org/software/libiconv) for the list of
809# possible encodings.
810# The default value is: UTF-8.
811
812INPUT_ENCODING = UTF-8
813
814# If the value of the INPUT tag contains directories, you can use the
815# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
816# *.h) to filter out the source-files in the directories.
817#
818# Note that for custom extensions or not directly supported extensions you also
819# need to set EXTENSION_MAPPING for the extension otherwise the files are not
820# read by doxygen.
821#
822# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
823# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
824# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
825# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
826# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
827
828FILE_PATTERNS = *.c \
829 *.cc \
830 *.cxx \
831 *.cpp \
832 *.c++ \
833 *.java \
834 *.ii \
835 *.ixx \
836 *.ipp \
837 *.i++ \
838 *.inl \
839 *.idl \
840 *.ddl \
841 *.odl \
842 *.h \
843 *.hh \
844 *.hxx \
845 *.hpp \
846 *.h++ \
847 *.cs \
848 *.d \
849 *.php \
850 *.php4 \
851 *.php5 \
852 *.phtml \
853 *.inc \
854 *.m \
855 *.markdown \
856 *.md \
857 *.mm \
858 *.dox \
859 *.py \
860 *.pyw \
861 *.f90 \
862 *.f95 \
863 *.f03 \
864 *.f08 \
865 *.f \
866 *.for \
867 *.tcl \
868 *.vhd \
869 *.vhdl \
870 *.ucf \
871 *.qsf
872
873# The RECURSIVE tag can be used to specify whether or not subdirectories should
874# be searched for input files as well.
875# The default value is: NO.
876
877RECURSIVE = NO
878
879# The EXCLUDE tag can be used to specify files and/or directories that should be
880# excluded from the INPUT source files. This way you can easily exclude a
881# subdirectory from a directory tree whose root is specified with the INPUT tag.
882#
883# Note that relative paths are relative to the directory from which doxygen is
884# run.
885
886EXCLUDE =
887
888# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
889# directories that are symbolic links (a Unix file system feature) are excluded
890# from the input.
891# The default value is: NO.
892
893EXCLUDE_SYMLINKS = NO
894
895# If the value of the INPUT tag contains directories, you can use the
896# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
897# certain files from those directories.
898#
899# Note that the wildcards are matched against the file with absolute path, so to
900# exclude all test directories for example use the pattern */test/*
901
902EXCLUDE_PATTERNS =
903
904# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
905# (namespaces, classes, functions, etc.) that should be excluded from the
906# output. The symbol name can be a fully qualified name, a word, or if the
907# wildcard * is used, a substring. Examples: ANamespace, AClass,
908# AClass::ANamespace, ANamespace::*Test
909#
910# Note that the wildcards are matched against the file with absolute path, so to
911# exclude all test directories use the pattern */test/*
912
913EXCLUDE_SYMBOLS =
914
915# The EXAMPLE_PATH tag can be used to specify one or more files or directories
916# that contain example code fragments that are included (see the \include
917# command).
918
919EXAMPLE_PATH = ./mainpage/markdeep
920
921# If the value of the EXAMPLE_PATH tag contains directories, you can use the
922# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
923# *.h) to filter out the source-files in the directories. If left blank all
924# files are included.
925
926EXAMPLE_PATTERNS = *
927
928# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
929# searched for input files to be used with the \include or \dontinclude commands
930# irrespective of the value of the RECURSIVE tag.
931# The default value is: NO.
932
933EXAMPLE_RECURSIVE = NO
934
935# The IMAGE_PATH tag can be used to specify one or more files or directories
936# that contain images that are to be included in the documentation (see the
937# \image command).
938
939IMAGE_PATH =
940
941# The INPUT_FILTER tag can be used to specify a program that doxygen should
942# invoke to filter for each input file. Doxygen will invoke the filter program
943# by executing (via popen()) the command:
944#
945# <filter> <input-file>
946#
947# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
948# name of an input file. Doxygen will then use the output that the filter
949# program writes to standard output. If FILTER_PATTERNS is specified, this tag
950# will be ignored.
951#
952# Note that the filter must not add or remove lines; it is applied before the
953# code is scanned, but not when the output code is generated. If lines are added
954# or removed, the anchors will not be placed correctly.
955#
956# Note that for custom extensions or not directly supported extensions you also
957# need to set EXTENSION_MAPPING for the extension otherwise the files are not
958# properly processed by doxygen.
959
960INPUT_FILTER =
961
962# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
963# basis. Doxygen will compare the file name with each pattern and apply the
964# filter if there is a match. The filters are a list of the form: pattern=filter
965# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
966# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
967# patterns match the file name, INPUT_FILTER is applied.
968#
969# Note that for custom extensions or not directly supported extensions you also
970# need to set EXTENSION_MAPPING for the extension otherwise the files are not
971# properly processed by doxygen.
972
973FILTER_PATTERNS =
974
975# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
976# INPUT_FILTER) will also be used to filter the input files that are used for
977# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
978# The default value is: NO.
979
980FILTER_SOURCE_FILES = NO
981
982# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
983# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
984# it is also possible to disable source filtering for a specific pattern using
985# *.ext= (so without naming a filter).
986# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
987
988FILTER_SOURCE_PATTERNS =
989
990# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
991# is part of the input, its contents will be placed on the main page
992# (index.html). This can be useful if you have a project on for instance GitHub
993# and want to reuse the introduction page also for the doxygen output.
994
995USE_MDFILE_AS_MAINPAGE =
996
997#---------------------------------------------------------------------------
998# Configuration options related to source browsing
999#---------------------------------------------------------------------------
1000
1001# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1002# generated. Documented entities will be cross-referenced with these sources.
1003#
1004# Note: To get rid of all source code in the generated output, make sure that
1005# also VERBATIM_HEADERS is set to NO.
1006# The default value is: NO.
1007
1008SOURCE_BROWSER = NO
1009
1010# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1011# classes and enums directly into the documentation.
1012# The default value is: NO.
1013
1014INLINE_SOURCES = NO
1015
1016# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1017# special comment blocks from generated source code fragments. Normal C, C++ and
1018# Fortran comments will always remain visible.
1019# The default value is: YES.
1020
1021STRIP_CODE_COMMENTS = YES
1022
1023# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1024# function all documented functions referencing it will be listed.
1025# The default value is: NO.
1026
1027REFERENCED_BY_RELATION = NO
1028
1029# If the REFERENCES_RELATION tag is set to YES then for each documented function
1030# all documented entities called/used by that function will be listed.
1031# The default value is: NO.
1032
1033REFERENCES_RELATION = NO
1034
1035# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1036# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1037# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1038# link to the documentation.
1039# The default value is: YES.
1040
1041REFERENCES_LINK_SOURCE = YES
1042
1043# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1044# source code will show a tooltip with additional information such as prototype,
1045# brief description and links to the definition and documentation. Since this
1046# will make the HTML file larger and loading of large files a bit slower, you
1047# can opt to disable this feature.
1048# The default value is: YES.
1049# This tag requires that the tag SOURCE_BROWSER is set to YES.
1050
1051SOURCE_TOOLTIPS = YES
1052
1053# If the USE_HTAGS tag is set to YES then the references to source code will
1054# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1055# source browser. The htags tool is part of GNU's global source tagging system
1056# (see http://www.gnu.org/software/global/global.html). You will need version
1057# 4.8.6 or higher.
1058#
1059# To use it do the following:
1060# - Install the latest version of global
1061# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1062# - Make sure the INPUT points to the root of the source tree
1063# - Run doxygen as normal
1064#
1065# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1066# tools must be available from the command line (i.e. in the search path).
1067#
1068# The result: instead of the source browser generated by doxygen, the links to
1069# source code will now point to the output of htags.
1070# The default value is: NO.
1071# This tag requires that the tag SOURCE_BROWSER is set to YES.
1072
1073USE_HTAGS = NO
1074
1075# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1076# verbatim copy of the header file for each class for which an include is
1077# specified. Set to NO to disable this.
1078# See also: Section \class.
1079# The default value is: YES.
1080
1081VERBATIM_HEADERS = YES
1082
1083# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1084# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1085# cost of reduced performance. This can be particularly helpful with template
1086# rich C++ code for which doxygen's built-in parser lacks the necessary type
1087# information.
1088# Note: The availability of this option depends on whether or not doxygen was
1089# generated with the -Duse-libclang=ON option for CMake.
1090# The default value is: NO.
1091
1092CLANG_ASSISTED_PARSING = NO
1093
1094# If clang assisted parsing is enabled you can provide the compiler with command
1095# line options that you would normally use when invoking the compiler. Note that
1096# the include paths will already be set by doxygen for the files and directories
1097# specified with INPUT and INCLUDE_PATH.
1098# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1099
1100CLANG_OPTIONS =
1101
1102#---------------------------------------------------------------------------
1103# Configuration options related to the alphabetical class index
1104#---------------------------------------------------------------------------
1105
1106# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1107# compounds will be generated. Enable this if the project contains a lot of
1108# classes, structs, unions or interfaces.
1109# The default value is: YES.
1110
1111ALPHABETICAL_INDEX = YES
1112
1113# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1114# which the alphabetical index list will be split.
1115# Minimum value: 1, maximum value: 20, default value: 5.
1116# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1117
1118COLS_IN_ALPHA_INDEX = 5
1119
1120# In case all classes in a project start with a common prefix, all classes will
1121# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1122# can be used to specify a prefix (or a list of prefixes) that should be ignored
1123# while generating the index headers.
1124# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1125
1126IGNORE_PREFIX =
1127
1128#---------------------------------------------------------------------------
1129# Configuration options related to the HTML output
1130#---------------------------------------------------------------------------
1131
1132# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1133# The default value is: YES.
1134
1135GENERATE_HTML = YES
1136
1137# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1138# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1139# it.
1140# The default directory is: html.
1141# This tag requires that the tag GENERATE_HTML is set to YES.
1142
1143HTML_OUTPUT = html
1144
1145# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1146# generated HTML page (for example: .htm, .php, .asp).
1147# The default value is: .html.
1148# This tag requires that the tag GENERATE_HTML is set to YES.
1149
1150HTML_FILE_EXTENSION = .html
1151
1152# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1153# each generated HTML page. If the tag is left blank doxygen will generate a
1154# standard header.
1155#
1156# To get valid HTML the header file that includes any scripts and style sheets
1157# that doxygen needs, which is dependent on the configuration options used (e.g.
1158# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1159# default header using
1160# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1161# YourConfigFile
1162# and then modify the file new_header.html. See also section "Doxygen usage"
1163# for information on how to generate the default header that doxygen normally
1164# uses.
1165# Note: The header is subject to change so you typically have to regenerate the
1166# default header when upgrading to a newer version of doxygen. For a description
1167# of the possible markers and block names see the documentation.
1168# This tag requires that the tag GENERATE_HTML is set to YES.
1169
1170HTML_HEADER =
1171
1172# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1173# generated HTML page. If the tag is left blank doxygen will generate a standard
1174# footer. See HTML_HEADER for more information on how to generate a default
1175# footer and what special commands can be used inside the footer. See also
1176# section "Doxygen usage" for information on how to generate the default footer
1177# that doxygen normally uses.
1178# This tag requires that the tag GENERATE_HTML is set to YES.
1179
1180HTML_FOOTER = ./footer.html
1181
1182# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1183# sheet that is used by each HTML page. It can be used to fine-tune the look of
1184# the HTML output. If left blank doxygen will generate a default style sheet.
1185# See also section "Doxygen usage" for information on how to generate the style
1186# sheet that doxygen normally uses.
1187# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1188# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1189# obsolete.
1190# This tag requires that the tag GENERATE_HTML is set to YES.
1191
1192HTML_STYLESHEET =
1193
1194# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1195# cascading style sheets that are included after the standard style sheets
1196# created by doxygen. Using this option one can overrule certain style aspects.
1197# This is preferred over using HTML_STYLESHEET since it does not replace the
1198# standard style sheet and is therefore more robust against future updates.
1199# Doxygen will copy the style sheet files to the output directory.
1200# Note: The order of the extra style sheet files is of importance (e.g. the last
1201# style sheet in the list overrules the setting of the previous ones in the
1202# list). For an example see the documentation.
1203# This tag requires that the tag GENERATE_HTML is set to YES.
1204
1205HTML_EXTRA_STYLESHEET = ./customdoxygen.css
1206
1207# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1208# other source files which should be copied to the HTML output directory. Note
1209# that these files will be copied to the base HTML output directory. Use the
1210# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1211# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1212# files will be copied as-is; there are no commands or markers available.
1213# This tag requires that the tag GENERATE_HTML is set to YES.
1214
1215HTML_EXTRA_FILES =
1216
1217# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1218# will adjust the colors in the style sheet and background images according to
1219# this color. Hue is specified as an angle on a colorwheel, see
1220# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1221# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1222# purple, and 360 is red again.
1223# Minimum value: 0, maximum value: 359, default value: 220.
1224# This tag requires that the tag GENERATE_HTML is set to YES.
1225
1226HTML_COLORSTYLE_HUE = 220
1227
1228# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1229# in the HTML output. For a value of 0 the output will use grayscales only. A
1230# value of 255 will produce the most vivid colors.
1231# Minimum value: 0, maximum value: 255, default value: 100.
1232# This tag requires that the tag GENERATE_HTML is set to YES.
1233
1234HTML_COLORSTYLE_SAT = 100
1235
1236# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1237# luminance component of the colors in the HTML output. Values below 100
1238# gradually make the output lighter, whereas values above 100 make the output
1239# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1240# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1241# change the gamma.
1242# Minimum value: 40, maximum value: 240, default value: 80.
1243# This tag requires that the tag GENERATE_HTML is set to YES.
1244
1245HTML_COLORSTYLE_GAMMA = 80
1246
1247# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1248# page will contain the date and time when the page was generated. Setting this
1249# to YES can help to show when doxygen was last run and thus if the
1250# documentation is up to date.
1251# The default value is: NO.
1252# This tag requires that the tag GENERATE_HTML is set to YES.
1253
1254HTML_TIMESTAMP = NO
1255
1256# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1257# documentation will contain sections that can be hidden and shown after the
1258# page has loaded.
1259# The default value is: NO.
1260# This tag requires that the tag GENERATE_HTML is set to YES.
1261
1262HTML_DYNAMIC_SECTIONS = NO
1263
1264# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1265# shown in the various tree structured indices initially; the user can expand
1266# and collapse entries dynamically later on. Doxygen will expand the tree to
1267# such a level that at most the specified number of entries are visible (unless
1268# a fully collapsed tree already exceeds this amount). So setting the number of
1269# entries 1 will produce a full collapsed tree by default. 0 is a special value
1270# representing an infinite number of entries and will result in a full expanded
1271# tree by default.
1272# Minimum value: 0, maximum value: 9999, default value: 100.
1273# This tag requires that the tag GENERATE_HTML is set to YES.
1274
1275HTML_INDEX_NUM_ENTRIES = 100
1276
1277# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1278# generated that can be used as input for Apple's Xcode 3 integrated development
1279# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1280# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1281# Makefile in the HTML output directory. Running make will produce the docset in
1282# that directory and running make install will install the docset in
1283# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1284# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1285# for more information.
1286# The default value is: NO.
1287# This tag requires that the tag GENERATE_HTML is set to YES.
1288
1289GENERATE_DOCSET = NO
1290
1291# This tag determines the name of the docset feed. A documentation feed provides
1292# an umbrella under which multiple documentation sets from a single provider
1293# (such as a company or product suite) can be grouped.
1294# The default value is: Doxygen generated docs.
1295# This tag requires that the tag GENERATE_DOCSET is set to YES.
1296
1297DOCSET_FEEDNAME = "Doxygen generated docs"
1298
1299# This tag specifies a string that should uniquely identify the documentation
1300# set bundle. This should be a reverse domain-name style string, e.g.
1301# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1302# The default value is: org.doxygen.Project.
1303# This tag requires that the tag GENERATE_DOCSET is set to YES.
1304
1305DOCSET_BUNDLE_ID = org.doxygen.Project
1306
1307# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1308# the documentation publisher. This should be a reverse domain-name style
1309# string, e.g. com.mycompany.MyDocSet.documentation.
1310# The default value is: org.doxygen.Publisher.
1311# This tag requires that the tag GENERATE_DOCSET is set to YES.
1312
1313DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1314
1315# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1316# The default value is: Publisher.
1317# This tag requires that the tag GENERATE_DOCSET is set to YES.
1318
1319DOCSET_PUBLISHER_NAME = Publisher
1320
1321# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1322# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1323# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1324# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1325# Windows.
1326#
1327# The HTML Help Workshop contains a compiler that can convert all HTML output
1328# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1329# files are now used as the Windows 98 help format, and will replace the old
1330# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1331# HTML files also contain an index, a table of contents, and you can search for
1332# words in the documentation. The HTML workshop also contains a viewer for
1333# compressed HTML files.
1334# The default value is: NO.
1335# This tag requires that the tag GENERATE_HTML is set to YES.
1336
1337GENERATE_HTMLHELP = NO
1338
1339# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1340# file. You can add a path in front of the file if the result should not be
1341# written to the html output directory.
1342# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1343
1344CHM_FILE =
1345
1346# The HHC_LOCATION tag can be used to specify the location (absolute path
1347# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1348# doxygen will try to run the HTML help compiler on the generated index.hhp.
1349# The file has to be specified with full path.
1350# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1351
1352HHC_LOCATION =
1353
1354# The GENERATE_CHI flag controls if a separate .chi index file is generated
1355# (YES) or that it should be included in the master .chm file (NO).
1356# The default value is: NO.
1357# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1358
1359GENERATE_CHI = NO
1360
1361# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1362# and project file content.
1363# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1364
1365CHM_INDEX_ENCODING =
1366
1367# The BINARY_TOC flag controls whether a binary table of contents is generated
1368# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1369# enables the Previous and Next buttons.
1370# The default value is: NO.
1371# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1372
1373BINARY_TOC = NO
1374
1375# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1376# the table of contents of the HTML help documentation and to the tree view.
1377# The default value is: NO.
1378# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1379
1380TOC_EXPAND = NO
1381
1382# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1383# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1384# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1385# (.qch) of the generated HTML documentation.
1386# The default value is: NO.
1387# This tag requires that the tag GENERATE_HTML is set to YES.
1388
1389GENERATE_QHP = NO
1390
1391# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1392# the file name of the resulting .qch file. The path specified is relative to
1393# the HTML output folder.
1394# This tag requires that the tag GENERATE_QHP is set to YES.
1395
1396QCH_FILE =
1397
1398# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1399# Project output. For more information please see Qt Help Project / Namespace
1400# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1401# The default value is: org.doxygen.Project.
1402# This tag requires that the tag GENERATE_QHP is set to YES.
1403
1404QHP_NAMESPACE = org.doxygen.Project
1405
1406# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1407# Help Project output. For more information please see Qt Help Project / Virtual
1408# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1409# folders).
1410# The default value is: doc.
1411# This tag requires that the tag GENERATE_QHP is set to YES.
1412
1413QHP_VIRTUAL_FOLDER = doc
1414
1415# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1416# filter to add. For more information please see Qt Help Project / Custom
1417# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1418# filters).
1419# This tag requires that the tag GENERATE_QHP is set to YES.
1420
1421QHP_CUST_FILTER_NAME =
1422
1423# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1424# custom filter to add. For more information please see Qt Help Project / Custom
1425# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1426# filters).
1427# This tag requires that the tag GENERATE_QHP is set to YES.
1428
1429QHP_CUST_FILTER_ATTRS =
1430
1431# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1432# project's filter section matches. Qt Help Project / Filter Attributes (see:
1433# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1434# This tag requires that the tag GENERATE_QHP is set to YES.
1435
1436QHP_SECT_FILTER_ATTRS =
1437
1438# The QHG_LOCATION tag can be used to specify the location of Qt's
1439# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1440# generated .qhp file.
1441# This tag requires that the tag GENERATE_QHP is set to YES.
1442
1443QHG_LOCATION =
1444
1445# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1446# generated, together with the HTML files, they form an Eclipse help plugin. To
1447# install this plugin and make it available under the help contents menu in
1448# Eclipse, the contents of the directory containing the HTML and XML files needs
1449# to be copied into the plugins directory of eclipse. The name of the directory
1450# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1451# After copying Eclipse needs to be restarted before the help appears.
1452# The default value is: NO.
1453# This tag requires that the tag GENERATE_HTML is set to YES.
1454
1455GENERATE_ECLIPSEHELP = NO
1456
1457# A unique identifier for the Eclipse help plugin. When installing the plugin
1458# the directory name containing the HTML and XML files should also have this
1459# name. Each documentation set should have its own identifier.
1460# The default value is: org.doxygen.Project.
1461# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1462
1463ECLIPSE_DOC_ID = org.doxygen.Project
1464
1465# If you want full control over the layout of the generated HTML pages it might
1466# be necessary to disable the index and replace it with your own. The
1467# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1468# of each HTML page. A value of NO enables the index and the value YES disables
1469# it. Since the tabs in the index contain the same information as the navigation
1470# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1471# The default value is: NO.
1472# This tag requires that the tag GENERATE_HTML is set to YES.
1473
1474DISABLE_INDEX = NO
1475
1476# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1477# structure should be generated to display hierarchical information. If the tag
1478# value is set to YES, a side panel will be generated containing a tree-like
1479# index structure (just like the one that is generated for HTML Help). For this
1480# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1481# (i.e. any modern browser). Windows users are probably better off using the
1482# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1483# further fine-tune the look of the index. As an example, the default style
1484# sheet generated by doxygen has an example that shows how to put an image at
1485# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1486# the same information as the tab index, you could consider setting
1487# DISABLE_INDEX to YES when enabling this option.
1488# The default value is: NO.
1489# This tag requires that the tag GENERATE_HTML is set to YES.
1490
1491GENERATE_TREEVIEW = YES
1492
1493# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1494# doxygen will group on one line in the generated HTML documentation.
1495#
1496# Note that a value of 0 will completely suppress the enum values from appearing
1497# in the overview section.
1498# Minimum value: 0, maximum value: 20, default value: 4.
1499# This tag requires that the tag GENERATE_HTML is set to YES.
1500
1501ENUM_VALUES_PER_LINE = 4
1502
1503# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1504# to set the initial width (in pixels) of the frame in which the tree is shown.
1505# Minimum value: 0, maximum value: 1500, default value: 250.
1506# This tag requires that the tag GENERATE_HTML is set to YES.
1507
1508TREEVIEW_WIDTH = 250
1509
1510# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1511# external symbols imported via tag files in a separate window.
1512# The default value is: NO.
1513# This tag requires that the tag GENERATE_HTML is set to YES.
1514
1515EXT_LINKS_IN_WINDOW = NO
1516
1517# Use this tag to change the font size of LaTeX formulas included as images in
1518# the HTML documentation. When you change the font size after a successful
1519# doxygen run you need to manually remove any form_*.png images from the HTML
1520# output directory to force them to be regenerated.
1521# Minimum value: 8, maximum value: 50, default value: 10.
1522# This tag requires that the tag GENERATE_HTML is set to YES.
1523
1524FORMULA_FONTSIZE = 10
1525
1526# Use the FORMULA_TRANPARENT tag to determine whether or not the images
1527# generated for formulas are transparent PNGs. Transparent PNGs are not
1528# supported properly for IE 6.0, but are supported on all modern browsers.
1529#
1530# Note that when changing this option you need to delete any form_*.png files in
1531# the HTML output directory before the changes have effect.
1532# The default value is: YES.
1533# This tag requires that the tag GENERATE_HTML is set to YES.
1534
1535FORMULA_TRANSPARENT = YES
1536
1537# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1538# http://www.mathjax.org) which uses client side Javascript for the rendering
1539# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1540# installed or if you want to formulas look prettier in the HTML output. When
1541# enabled you may also need to install MathJax separately and configure the path
1542# to it using the MATHJAX_RELPATH option.
1543# The default value is: NO.
1544# This tag requires that the tag GENERATE_HTML is set to YES.
1545
1546USE_MATHJAX = NO
1547
1548# When MathJax is enabled you can set the default output format to be used for
1549# the MathJax output. See the MathJax site (see:
1550# http://docs.mathjax.org/en/latest/output.html) for more details.
1551# Possible values are: HTML-CSS (which is slower, but has the best
1552# compatibility), NativeMML (i.e. MathML) and SVG.
1553# The default value is: HTML-CSS.
1554# This tag requires that the tag USE_MATHJAX is set to YES.
1555
1556MATHJAX_FORMAT = HTML-CSS
1557
1558# When MathJax is enabled you need to specify the location relative to the HTML
1559# output directory using the MATHJAX_RELPATH option. The destination directory
1560# should contain the MathJax.js script. For instance, if the mathjax directory
1561# is located at the same level as the HTML output directory, then
1562# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1563# Content Delivery Network so you can quickly see the result without installing
1564# MathJax. However, it is strongly recommended to install a local copy of
1565# MathJax from http://www.mathjax.org before deployment.
1566# The default value is: http://cdn.mathjax.org/mathjax/latest.
1567# This tag requires that the tag USE_MATHJAX is set to YES.
1568
1569MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1570
1571# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1572# extension names that should be enabled during MathJax rendering. For example
1573# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1574# This tag requires that the tag USE_MATHJAX is set to YES.
1575
1576MATHJAX_EXTENSIONS =
1577
1578# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1579# of code that will be used on startup of the MathJax code. See the MathJax site
1580# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1581# example see the documentation.
1582# This tag requires that the tag USE_MATHJAX is set to YES.
1583
1584MATHJAX_CODEFILE =
1585
1586# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1587# the HTML output. The underlying search engine uses javascript and DHTML and
1588# should work on any modern browser. Note that when using HTML help
1589# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1590# there is already a search function so this one should typically be disabled.
1591# For large projects the javascript based search engine can be slow, then
1592# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1593# search using the keyboard; to jump to the search box use <access key> + S
1594# (what the <access key> is depends on the OS and browser, but it is typically
1595# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1596# key> to jump into the search results window, the results can be navigated
1597# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1598# the search. The filter options can be selected when the cursor is inside the
1599# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1600# to select a filter and <Enter> or <escape> to activate or cancel the filter
1601# option.
1602# The default value is: YES.
1603# This tag requires that the tag GENERATE_HTML is set to YES.
1604
1605SEARCHENGINE = YES
1606
1607# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1608# implemented using a web server instead of a web client using Javascript. There
1609# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1610# setting. When disabled, doxygen will generate a PHP script for searching and
1611# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1612# and searching needs to be provided by external tools. See the section
1613# "External Indexing and Searching" for details.
1614# The default value is: NO.
1615# This tag requires that the tag SEARCHENGINE is set to YES.
1616
1617SERVER_BASED_SEARCH = NO
1618
1619# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1620# script for searching. Instead the search results are written to an XML file
1621# which needs to be processed by an external indexer. Doxygen will invoke an
1622# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1623# search results.
1624#
1625# Doxygen ships with an example indexer (doxyindexer) and search engine
1626# (doxysearch.cgi) which are based on the open source search engine library
1627# Xapian (see: http://xapian.org/).
1628#
1629# See the section "External Indexing and Searching" for details.
1630# The default value is: NO.
1631# This tag requires that the tag SEARCHENGINE is set to YES.
1632
1633EXTERNAL_SEARCH = NO
1634
1635# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1636# which will return the search results when EXTERNAL_SEARCH is enabled.
1637#
1638# Doxygen ships with an example indexer (doxyindexer) and search engine
1639# (doxysearch.cgi) which are based on the open source search engine library
1640# Xapian (see: http://xapian.org/). See the section "External Indexing and
1641# Searching" for details.
1642# This tag requires that the tag SEARCHENGINE is set to YES.
1643
1644SEARCHENGINE_URL =
1645
1646# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1647# search data is written to a file for indexing by an external tool. With the
1648# SEARCHDATA_FILE tag the name of this file can be specified.
1649# The default file is: searchdata.xml.
1650# This tag requires that the tag SEARCHENGINE is set to YES.
1651
1652SEARCHDATA_FILE = searchdata.xml
1653
1654# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1655# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1656# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1657# projects and redirect the results back to the right project.
1658# This tag requires that the tag SEARCHENGINE is set to YES.
1659
1660EXTERNAL_SEARCH_ID =
1661
1662# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1663# projects other than the one defined by this configuration file, but that are
1664# all added to the same external search index. Each project needs to have a
1665# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1666# to a relative location where the documentation can be found. The format is:
1667# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1668# This tag requires that the tag SEARCHENGINE is set to YES.
1669
1670EXTRA_SEARCH_MAPPINGS =
1671
1672#---------------------------------------------------------------------------
1673# Configuration options related to the LaTeX output
1674#---------------------------------------------------------------------------
1675
1676# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1677# The default value is: YES.
1678
1679GENERATE_LATEX = NO
1680
1681# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1682# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1683# it.
1684# The default directory is: latex.
1685# This tag requires that the tag GENERATE_LATEX is set to YES.
1686
1687LATEX_OUTPUT = latex
1688
1689# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1690# invoked.
1691#
1692# Note that when enabling USE_PDFLATEX this option is only used for generating
1693# bitmaps for formulas in the HTML output, but not in the Makefile that is
1694# written to the output directory.
1695# The default file is: latex.
1696# This tag requires that the tag GENERATE_LATEX is set to YES.
1697
1698LATEX_CMD_NAME = latex
1699
1700# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1701# index for LaTeX.
1702# The default file is: makeindex.
1703# This tag requires that the tag GENERATE_LATEX is set to YES.
1704
1705MAKEINDEX_CMD_NAME = makeindex
1706
1707# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1708# documents. This may be useful for small projects and may help to save some
1709# trees in general.
1710# The default value is: NO.
1711# This tag requires that the tag GENERATE_LATEX is set to YES.
1712
1713COMPACT_LATEX = NO
1714
1715# The PAPER_TYPE tag can be used to set the paper type that is used by the
1716# printer.
1717# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1718# 14 inches) and executive (7.25 x 10.5 inches).
1719# The default value is: a4.
1720# This tag requires that the tag GENERATE_LATEX is set to YES.
1721
1722PAPER_TYPE = a4
1723
1724# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1725# that should be included in the LaTeX output. The package can be specified just
1726# by its name or with the correct syntax as to be used with the LaTeX
1727# \usepackage command. To get the times font for instance you can specify :
1728# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1729# To use the option intlimits with the amsmath package you can specify:
1730# EXTRA_PACKAGES=[intlimits]{amsmath}
1731# If left blank no extra packages will be included.
1732# This tag requires that the tag GENERATE_LATEX is set to YES.
1733
1734EXTRA_PACKAGES =
1735
1736# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1737# generated LaTeX document. The header should contain everything until the first
1738# chapter. If it is left blank doxygen will generate a standard header. See
1739# section "Doxygen usage" for information on how to let doxygen write the
1740# default header to a separate file.
1741#
1742# Note: Only use a user-defined header if you know what you are doing! The
1743# following commands have a special meaning inside the header: $title,
1744# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1745# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1746# string, for the replacement values of the other commands the user is referred
1747# to HTML_HEADER.
1748# This tag requires that the tag GENERATE_LATEX is set to YES.
1749
1750LATEX_HEADER =
1751
1752# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1753# generated LaTeX document. The footer should contain everything after the last
1754# chapter. If it is left blank doxygen will generate a standard footer. See
1755# LATEX_HEADER for more information on how to generate a default footer and what
1756# special commands can be used inside the footer.
1757#
1758# Note: Only use a user-defined footer if you know what you are doing!
1759# This tag requires that the tag GENERATE_LATEX is set to YES.
1760
1761LATEX_FOOTER =
1762
1763# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1764# LaTeX style sheets that are included after the standard style sheets created
1765# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1766# will copy the style sheet files to the output directory.
1767# Note: The order of the extra style sheet files is of importance (e.g. the last
1768# style sheet in the list overrules the setting of the previous ones in the
1769# list).
1770# This tag requires that the tag GENERATE_LATEX is set to YES.
1771
1772LATEX_EXTRA_STYLESHEET =
1773
1774# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1775# other source files which should be copied to the LATEX_OUTPUT output
1776# directory. Note that the files will be copied as-is; there are no commands or
1777# markers available.
1778# This tag requires that the tag GENERATE_LATEX is set to YES.
1779
1780LATEX_EXTRA_FILES =
1781
1782# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1783# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1784# contain links (just like the HTML output) instead of page references. This
1785# makes the output suitable for online browsing using a PDF viewer.
1786# The default value is: YES.
1787# This tag requires that the tag GENERATE_LATEX is set to YES.
1788
1789PDF_HYPERLINKS = YES
1790
1791# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1792# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1793# higher quality PDF documentation.
1794# The default value is: YES.
1795# This tag requires that the tag GENERATE_LATEX is set to YES.
1796
1797USE_PDFLATEX = YES
1798
1799# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1800# command to the generated LaTeX files. This will instruct LaTeX to keep running
1801# if errors occur, instead of asking the user for help. This option is also used
1802# when generating formulas in HTML.
1803# The default value is: NO.
1804# This tag requires that the tag GENERATE_LATEX is set to YES.
1805
1806LATEX_BATCHMODE = NO
1807
1808# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1809# index chapters (such as File Index, Compound Index, etc.) in the output.
1810# The default value is: NO.
1811# This tag requires that the tag GENERATE_LATEX is set to YES.
1812
1813LATEX_HIDE_INDICES = NO
1814
1815# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1816# code with syntax highlighting in the LaTeX output.
1817#
1818# Note that which sources are shown also depends on other settings such as
1819# SOURCE_BROWSER.
1820# The default value is: NO.
1821# This tag requires that the tag GENERATE_LATEX is set to YES.
1822
1823LATEX_SOURCE_CODE = NO
1824
1825# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1826# bibliography, e.g. plainnat, or ieeetr. See
1827# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1828# The default value is: plain.
1829# This tag requires that the tag GENERATE_LATEX is set to YES.
1830
1831LATEX_BIB_STYLE = plain
1832
1833# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1834# page will contain the date and time when the page was generated. Setting this
1835# to NO can help when comparing the output of multiple runs.
1836# The default value is: NO.
1837# This tag requires that the tag GENERATE_LATEX is set to YES.
1838
1839LATEX_TIMESTAMP = NO
1840
1841#---------------------------------------------------------------------------
1842# Configuration options related to the RTF output
1843#---------------------------------------------------------------------------
1844
1845# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1846# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1847# readers/editors.
1848# The default value is: NO.
1849
1850GENERATE_RTF = NO
1851
1852# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1853# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1854# it.
1855# The default directory is: rtf.
1856# This tag requires that the tag GENERATE_RTF is set to YES.
1857
1858RTF_OUTPUT = rtf
1859
1860# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1861# documents. This may be useful for small projects and may help to save some
1862# trees in general.
1863# The default value is: NO.
1864# This tag requires that the tag GENERATE_RTF is set to YES.
1865
1866COMPACT_RTF = NO
1867
1868# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1869# contain hyperlink fields. The RTF file will contain links (just like the HTML
1870# output) instead of page references. This makes the output suitable for online
1871# browsing using Word or some other Word compatible readers that support those
1872# fields.
1873#
1874# Note: WordPad (write) and others do not support links.
1875# The default value is: NO.
1876# This tag requires that the tag GENERATE_RTF is set to YES.
1877
1878RTF_HYPERLINKS = NO
1879
1880# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1881# file, i.e. a series of assignments. You only have to provide replacements,
1882# missing definitions are set to their default value.
1883#
1884# See also section "Doxygen usage" for information on how to generate the
1885# default style sheet that doxygen normally uses.
1886# This tag requires that the tag GENERATE_RTF is set to YES.
1887
1888RTF_STYLESHEET_FILE =
1889
1890# Set optional variables used in the generation of an RTF document. Syntax is
1891# similar to doxygen's config file. A template extensions file can be generated
1892# using doxygen -e rtf extensionFile.
1893# This tag requires that the tag GENERATE_RTF is set to YES.
1894
1895RTF_EXTENSIONS_FILE =
1896
1897# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1898# with syntax highlighting in the RTF output.
1899#
1900# Note that which sources are shown also depends on other settings such as
1901# SOURCE_BROWSER.
1902# The default value is: NO.
1903# This tag requires that the tag GENERATE_RTF is set to YES.
1904
1905RTF_SOURCE_CODE = NO
1906
1907#---------------------------------------------------------------------------
1908# Configuration options related to the man page output
1909#---------------------------------------------------------------------------
1910
1911# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1912# classes and files.
1913# The default value is: NO.
1914
1915GENERATE_MAN = NO
1916
1917# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1918# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1919# it. A directory man3 will be created inside the directory specified by
1920# MAN_OUTPUT.
1921# The default directory is: man.
1922# This tag requires that the tag GENERATE_MAN is set to YES.
1923
1924MAN_OUTPUT = man
1925
1926# The MAN_EXTENSION tag determines the extension that is added to the generated
1927# man pages. In case the manual section does not start with a number, the number
1928# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1929# optional.
1930# The default value is: .3.
1931# This tag requires that the tag GENERATE_MAN is set to YES.
1932
1933MAN_EXTENSION = .3
1934
1935# The MAN_SUBDIR tag determines the name of the directory created within
1936# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1937# MAN_EXTENSION with the initial . removed.
1938# This tag requires that the tag GENERATE_MAN is set to YES.
1939
1940MAN_SUBDIR =
1941
1942# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1943# will generate one additional man file for each entity documented in the real
1944# man page(s). These additional files only source the real man page, but without
1945# them the man command would be unable to find the correct page.
1946# The default value is: NO.
1947# This tag requires that the tag GENERATE_MAN is set to YES.
1948
1949MAN_LINKS = NO
1950
1951#---------------------------------------------------------------------------
1952# Configuration options related to the XML output
1953#---------------------------------------------------------------------------
1954
1955# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1956# captures the structure of the code including all documentation.
1957# The default value is: NO.
1958
1959GENERATE_XML = NO
1960
1961# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
1962# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1963# it.
1964# The default directory is: xml.
1965# This tag requires that the tag GENERATE_XML is set to YES.
1966
1967XML_OUTPUT = xml
1968
1969# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
1970# listings (including syntax highlighting and cross-referencing information) to
1971# the XML output. Note that enabling this will significantly increase the size
1972# of the XML output.
1973# The default value is: YES.
1974# This tag requires that the tag GENERATE_XML is set to YES.
1975
1976XML_PROGRAMLISTING = YES
1977
1978#---------------------------------------------------------------------------
1979# Configuration options related to the DOCBOOK output
1980#---------------------------------------------------------------------------
1981
1982# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
1983# that can be used to generate PDF.
1984# The default value is: NO.
1985
1986GENERATE_DOCBOOK = NO
1987
1988# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
1989# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
1990# front of it.
1991# The default directory is: docbook.
1992# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
1993
1994DOCBOOK_OUTPUT = docbook
1995
1996# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
1997# program listings (including syntax highlighting and cross-referencing
1998# information) to the DOCBOOK output. Note that enabling this will significantly
1999# increase the size of the DOCBOOK output.
2000# The default value is: NO.
2001# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2002
2003DOCBOOK_PROGRAMLISTING = NO
2004
2005#---------------------------------------------------------------------------
2006# Configuration options for the AutoGen Definitions output
2007#---------------------------------------------------------------------------
2008
2009# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2010# AutoGen Definitions (see http://autogen.sf.net) file that captures the
2011# structure of the code including all documentation. Note that this feature is
2012# still experimental and incomplete at the moment.
2013# The default value is: NO.
2014
2015GENERATE_AUTOGEN_DEF = NO
2016
2017#---------------------------------------------------------------------------
2018# Configuration options related to the Perl module output
2019#---------------------------------------------------------------------------
2020
2021# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2022# file that captures the structure of the code including all documentation.
2023#
2024# Note that this feature is still experimental and incomplete at the moment.
2025# The default value is: NO.
2026
2027GENERATE_PERLMOD = NO
2028
2029# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2030# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2031# output from the Perl module output.
2032# The default value is: NO.
2033# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2034
2035PERLMOD_LATEX = NO
2036
2037# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2038# formatted so it can be parsed by a human reader. This is useful if you want to
2039# understand what is going on. On the other hand, if this tag is set to NO, the
2040# size of the Perl module output will be much smaller and Perl will parse it
2041# just the same.
2042# The default value is: YES.
2043# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2044
2045PERLMOD_PRETTY = YES
2046
2047# The names of the make variables in the generated doxyrules.make file are
2048# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2049# so different doxyrules.make files included by the same Makefile don't
2050# overwrite each other's variables.
2051# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2052
2053PERLMOD_MAKEVAR_PREFIX =
2054
2055#---------------------------------------------------------------------------
2056# Configuration options related to the preprocessor
2057#---------------------------------------------------------------------------
2058
2059# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2060# C-preprocessor directives found in the sources and include files.
2061# The default value is: YES.
2062
2063ENABLE_PREPROCESSING = YES
2064
2065# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2066# in the source code. If set to NO, only conditional compilation will be
2067# performed. Macro expansion can be done in a controlled way by setting
2068# EXPAND_ONLY_PREDEF to YES.
2069# The default value is: NO.
2070# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2071
2072MACRO_EXPANSION = YES
2073
2074# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2075# the macro expansion is limited to the macros specified with the PREDEFINED and
2076# EXPAND_AS_DEFINED tags.
2077# The default value is: NO.
2078# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2079
2080EXPAND_ONLY_PREDEF = YES
2081
2082# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2083# INCLUDE_PATH will be searched if a #include is found.
2084# The default value is: YES.
2085# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2086
2087SEARCH_INCLUDES = YES
2088
2089# The INCLUDE_PATH tag can be used to specify one or more directories that
2090# contain include files that are not input files but should be processed by the
2091# preprocessor.
2092# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2093
2094INCLUDE_PATH =
2095
2096# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2097# patterns (like *.h and *.hpp) to filter out the header-files in the
2098# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2099# used.
2100# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2101
2102INCLUDE_FILE_PATTERNS =
2103
2104# The PREDEFINED tag can be used to specify one or more macro names that are
2105# defined before the preprocessor is started (similar to the -D option of e.g.
2106# gcc). The argument of the tag is a list of macros of the form: name or
2107# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2108# is assumed. To prevent a macro definition from being undefined via #undef or
2109# recursively expanded use the := operator instead of the = operator.
2110# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2111
2112PREDEFINED =
2113
2114# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2115# tag can be used to specify a list of macro names that should be expanded. The
2116# macro definition that is found in the sources will be used. Use the PREDEFINED
2117# tag if you want to use a different macro definition that overrules the
2118# definition found in the source code.
2119# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2120
2121EXPAND_AS_DEFINED = SkDEBUGCODE
2122
2123# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2124# remove all references to function-like macros that are alone on a line, have
2125# an all uppercase name, and do not end with a semicolon. Such function macros
2126# are typically used for boiler-plate code, and will confuse the parser if not
2127# removed.
2128# The default value is: YES.
2129# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2130
2131SKIP_FUNCTION_MACROS = YES
2132
2133#---------------------------------------------------------------------------
2134# Configuration options related to external references
2135#---------------------------------------------------------------------------
2136
2137# The TAGFILES tag can be used to specify one or more tag files. For each tag
2138# file the location of the external documentation should be added. The format of
2139# a tag file without this location is as follows:
2140# TAGFILES = file1 file2 ...
2141# Adding location for the tag files is done as follows:
2142# TAGFILES = file1=loc1 "file2 = loc2" ...
2143# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2144# section "Linking to external documentation" for more information about the use
2145# of tag files.
2146# Note: Each tag file must have a unique name (where the name does NOT include
2147# the path). If a tag file is not located in the directory in which doxygen is
2148# run, you must also specify the path to the tagfile here.
2149
2150TAGFILES =
2151
2152# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2153# tag file that is based on the input files it reads. See section "Linking to
2154# external documentation" for more information about the usage of tag files.
2155
2156GENERATE_TAGFILE =
2157
2158# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2159# the class index. If set to NO, only the inherited external classes will be
2160# listed.
2161# The default value is: NO.
2162
2163ALLEXTERNALS = NO
2164
2165# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2166# in the modules index. If set to NO, only the current project's groups will be
2167# listed.
2168# The default value is: YES.
2169
2170EXTERNAL_GROUPS = YES
2171
2172# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2173# the related pages index. If set to NO, only the current project's pages will
2174# be listed.
2175# The default value is: YES.
2176
2177EXTERNAL_PAGES = YES
2178
2179# The PERL_PATH should be the absolute path and name of the perl script
2180# interpreter (i.e. the result of 'which perl').
2181# The default file (with absolute path) is: /usr/bin/perl.
2182
2183PERL_PATH = /usr/bin/perl
2184
2185#---------------------------------------------------------------------------
2186# Configuration options related to the dot tool
2187#---------------------------------------------------------------------------
2188
2189# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2190# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2191# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2192# disabled, but it is recommended to install and use dot, since it yields more
2193# powerful graphs.
2194# The default value is: YES.
2195
2196CLASS_DIAGRAMS = YES
2197
2198# You can define message sequence charts within doxygen comments using the \msc
2199# command. Doxygen will then run the mscgen tool (see:
2200# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2201# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2202# the mscgen tool resides. If left empty the tool is assumed to be found in the
2203# default search path.
2204
2205MSCGEN_PATH =
2206
2207# You can include diagrams made with dia in doxygen documentation. Doxygen will
2208# then run dia to produce the diagram and insert it in the documentation. The
2209# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2210# If left empty dia is assumed to be found in the default search path.
2211
2212DIA_PATH =
2213
2214# If set to YES the inheritance and collaboration graphs will hide inheritance
2215# and usage relations if the target is undocumented or is not a class.
2216# The default value is: YES.
2217
2218HIDE_UNDOC_RELATIONS = YES
2219
2220# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2221# available from the path. This tool is part of Graphviz (see:
2222# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2223# Bell Labs. The other options in this section have no effect if this option is
2224# set to NO
2225# The default value is: YES.
2226
2227HAVE_DOT = YES
2228
2229# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2230# to run in parallel. When set to 0 doxygen will base this on the number of
2231# processors available in the system. You can set it explicitly to a value
2232# larger than 0 to get control over the balance between CPU load and processing
2233# speed.
2234# Minimum value: 0, maximum value: 32, default value: 0.
2235# This tag requires that the tag HAVE_DOT is set to YES.
2236
2237DOT_NUM_THREADS = 0
2238
2239# When you want a differently looking font in the dot files that doxygen
2240# generates you can specify the font name using DOT_FONTNAME. You need to make
2241# sure dot is able to find the font, which can be done by putting it in a
2242# standard location or by setting the DOTFONTPATH environment variable or by
2243# setting DOT_FONTPATH to the directory containing the font.
2244# The default value is: Helvetica.
2245# This tag requires that the tag HAVE_DOT is set to YES.
2246
2247DOT_FONTNAME = Helvetica
2248
2249# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2250# dot graphs.
2251# Minimum value: 4, maximum value: 24, default value: 10.
2252# This tag requires that the tag HAVE_DOT is set to YES.
2253
2254DOT_FONTSIZE = 10
2255
2256# By default doxygen will tell dot to use the default font as specified with
2257# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2258# the path where dot can find it using this tag.
2259# This tag requires that the tag HAVE_DOT is set to YES.
2260
2261DOT_FONTPATH =
2262
2263# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2264# each documented class showing the direct and indirect inheritance relations.
2265# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2266# The default value is: YES.
2267# This tag requires that the tag HAVE_DOT is set to YES.
2268
2269CLASS_GRAPH = YES
2270
2271# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2272# graph for each documented class showing the direct and indirect implementation
2273# dependencies (inheritance, containment, and class references variables) of the
2274# class with other documented classes.
2275# The default value is: YES.
2276# This tag requires that the tag HAVE_DOT is set to YES.
2277
2278COLLABORATION_GRAPH = NO
2279
2280# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2281# groups, showing the direct groups dependencies.
2282# The default value is: YES.
2283# This tag requires that the tag HAVE_DOT is set to YES.
2284
2285GROUP_GRAPHS = YES
2286
2287# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2288# collaboration diagrams in a style similar to the OMG's Unified Modeling
2289# Language.
2290# The default value is: NO.
2291# This tag requires that the tag HAVE_DOT is set to YES.
2292
2293UML_LOOK = NO
2294
2295# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2296# class node. If there are many fields or methods and many nodes the graph may
2297# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2298# number of items for each type to make the size more manageable. Set this to 0
2299# for no limit. Note that the threshold may be exceeded by 50% before the limit
2300# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2301# but if the number exceeds 15, the total amount of fields shown is limited to
2302# 10.
2303# Minimum value: 0, maximum value: 100, default value: 10.
2304# This tag requires that the tag HAVE_DOT is set to YES.
2305
2306UML_LIMIT_NUM_FIELDS = 10
2307
2308# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2309# collaboration graphs will show the relations between templates and their
2310# instances.
2311# The default value is: NO.
2312# This tag requires that the tag HAVE_DOT is set to YES.
2313
2314TEMPLATE_RELATIONS = NO
2315
2316# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2317# YES then doxygen will generate a graph for each documented file showing the
2318# direct and indirect include dependencies of the file with other documented
2319# files.
2320# The default value is: YES.
2321# This tag requires that the tag HAVE_DOT is set to YES.
2322
2323INCLUDE_GRAPH = YES
2324
2325# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2326# set to YES then doxygen will generate a graph for each documented file showing
2327# the direct and indirect include dependencies of the file with other documented
2328# files.
2329# The default value is: YES.
2330# This tag requires that the tag HAVE_DOT is set to YES.
2331
2332INCLUDED_BY_GRAPH = YES
2333
2334# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2335# dependency graph for every global function or class method.
2336#
2337# Note that enabling this option will significantly increase the time of a run.
2338# So in most cases it will be better to enable call graphs for selected
2339# functions only using the \callgraph command. Disabling a call graph can be
2340# accomplished by means of the command \hidecallgraph.
2341# The default value is: NO.
2342# This tag requires that the tag HAVE_DOT is set to YES.
2343
2344CALL_GRAPH = NO
2345
2346# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2347# dependency graph for every global function or class method.
2348#
2349# Note that enabling this option will significantly increase the time of a run.
2350# So in most cases it will be better to enable caller graphs for selected
2351# functions only using the \callergraph command. Disabling a caller graph can be
2352# accomplished by means of the command \hidecallergraph.
2353# The default value is: NO.
2354# This tag requires that the tag HAVE_DOT is set to YES.
2355
2356CALLER_GRAPH = NO
2357
2358# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2359# hierarchy of all classes instead of a textual one.
2360# The default value is: YES.
2361# This tag requires that the tag HAVE_DOT is set to YES.
2362
2363GRAPHICAL_HIERARCHY = YES
2364
2365# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2366# dependencies a directory has on other directories in a graphical way. The
2367# dependency relations are determined by the #include relations between the
2368# files in the directories.
2369# The default value is: YES.
2370# This tag requires that the tag HAVE_DOT is set to YES.
2371
2372DIRECTORY_GRAPH = YES
2373
2374# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2375# generated by dot. For an explanation of the image formats see the section
2376# output formats in the documentation of the dot tool (Graphviz (see:
2377# http://www.graphviz.org/)).
2378# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2379# to make the SVG files visible in IE 9+ (other browsers do not have this
2380# requirement).
2381# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2382# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2383# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
2384# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2385# png:gdiplus:gdiplus.
2386# The default value is: png.
2387# This tag requires that the tag HAVE_DOT is set to YES.
2388
2389DOT_IMAGE_FORMAT = png
2390
2391# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2392# enable generation of interactive SVG images that allow zooming and panning.
2393#
2394# Note that this requires a modern browser other than Internet Explorer. Tested
2395# and working are Firefox, Chrome, Safari, and Opera.
2396# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2397# the SVG files visible. Older versions of IE do not have SVG support.
2398# The default value is: NO.
2399# This tag requires that the tag HAVE_DOT is set to YES.
2400
2401INTERACTIVE_SVG = NO
2402
2403# The DOT_PATH tag can be used to specify the path where the dot tool can be
2404# found. If left blank, it is assumed the dot tool can be found in the path.
2405# This tag requires that the tag HAVE_DOT is set to YES.
2406
2407DOT_PATH =
2408
2409# The DOTFILE_DIRS tag can be used to specify one or more directories that
2410# contain dot files that are included in the documentation (see the \dotfile
2411# command).
2412# This tag requires that the tag HAVE_DOT is set to YES.
2413
2414DOTFILE_DIRS =
2415
2416# The MSCFILE_DIRS tag can be used to specify one or more directories that
2417# contain msc files that are included in the documentation (see the \mscfile
2418# command).
2419
2420MSCFILE_DIRS =
2421
2422# The DIAFILE_DIRS tag can be used to specify one or more directories that
2423# contain dia files that are included in the documentation (see the \diafile
2424# command).
2425
2426DIAFILE_DIRS =
2427
2428# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2429# path where java can find the plantuml.jar file. If left blank, it is assumed
2430# PlantUML is not used or called during a preprocessing step. Doxygen will
2431# generate a warning when it encounters a \startuml command in this case and
2432# will not generate output for the diagram.
2433
2434PLANTUML_JAR_PATH =
2435
2436# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2437# configuration file for plantuml.
2438
2439PLANTUML_CFG_FILE =
2440
2441# When using plantuml, the specified paths are searched for files specified by
2442# the !include statement in a plantuml block.
2443
2444PLANTUML_INCLUDE_PATH =
2445
2446# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2447# that will be shown in the graph. If the number of nodes in a graph becomes
2448# larger than this value, doxygen will truncate the graph, which is visualized
2449# by representing a node as a red box. Note that doxygen if the number of direct
2450# children of the root node in a graph is already larger than
2451# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2452# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2453# Minimum value: 0, maximum value: 10000, default value: 50.
2454# This tag requires that the tag HAVE_DOT is set to YES.
2455
2456DOT_GRAPH_MAX_NODES = 50
2457
2458# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2459# generated by dot. A depth value of 3 means that only nodes reachable from the
2460# root by following a path via at most 3 edges will be shown. Nodes that lay
2461# further from the root node will be omitted. Note that setting this option to 1
2462# or 2 may greatly reduce the computation time needed for large code bases. Also
2463# note that the size of a graph can be further restricted by
2464# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2465# Minimum value: 0, maximum value: 1000, default value: 0.
2466# This tag requires that the tag HAVE_DOT is set to YES.
2467
2468MAX_DOT_GRAPH_DEPTH = 0
2469
2470# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2471# background. This is disabled by default, because dot on Windows does not seem
2472# to support this out of the box.
2473#
2474# Warning: Depending on the platform used, enabling this option may lead to
2475# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2476# read).
2477# The default value is: NO.
2478# This tag requires that the tag HAVE_DOT is set to YES.
2479
2480DOT_TRANSPARENT = NO
2481
2482# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2483# files in one run (i.e. multiple -o and -T options on the command line). This
2484# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2485# this, this feature is disabled by default.
2486# The default value is: NO.
2487# This tag requires that the tag HAVE_DOT is set to YES.
2488
2489DOT_MULTI_TARGETS = NO
2490
2491# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2492# explaining the meaning of the various boxes and arrows in the dot generated
2493# graphs.
2494# The default value is: YES.
2495# This tag requires that the tag HAVE_DOT is set to YES.
2496
2497GENERATE_LEGEND = YES
2498
2499# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2500# files that are used to generate the various graphs.
2501# The default value is: YES.
2502# This tag requires that the tag HAVE_DOT is set to YES.
2503
2504DOT_CLEANUP = YES
2505