source: doc/web.cfg @ 0759f90

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchsampleryinfft+
Last change on this file since 0759f90 was 413bc0f, checked in by Paul Brossier <piem@piem.org>, 3 years ago

doc/: update to doxyfile 1.8.8

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