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