source: doc/full.cfg @ 154d9fc

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 154d9fc was 154d9fc, checked in by Paul Brossier <piem@piem.org>, 6 years ago

doc/*.cfg: bump version numbers here too

Signed-off-by: Paul Brossier <piem@piem.org>

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