source: doc/web.cfg @ b429b68

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since b429b68 was 1d01ebb4, checked in by Paul Brossier <piem@piem.org>, 11 years ago

doc/{full,web}.cfg: update project ids

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