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