Changeset bb42f65


Ignore:
Timestamp:
Mar 18, 2013, 4:34:01 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
b209eda
Parents:
ac20c85 (diff), a5f4b7d (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge branch 'pitchyinfft' into develop

Files:
4 edited

Legend:

Unmodified
Added
Removed
  • doc/full.cfg

    rac20c85 rbb42f65  
    1 # Doxyfile 1.6.1
     1# Doxyfile 1.8.3.1
    22
    33# This file describes the settings to be used by the documentation system
    4 # doxygen (www.doxygen.org) for a project
     4# doxygen (www.doxygen.org) for a project.
    55#
    6 # All text after a hash (#) is considered a comment and will be ignored
     6# All text after a hash (#) is considered a comment and will be ignored.
    77# The format is:
    88#       TAG = value [value, ...]
    99# For lists items can also be appended using:
    1010#       TAG += value [value, ...]
    11 # Values that contain spaces should be placed between quotes (" ")
     11# Values that contain spaces should be placed between quotes (" ").
    1212
    1313#---------------------------------------------------------------------------
     
    2323DOXYFILE_ENCODING      = UTF-8
    2424
    25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    26 # by quotes) that should identify the project.
    27 
     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.
    2828PROJECT_NAME           = aubio
    2929
     
    3333
    3434PROJECT_NUMBER         = "0.4.0alpha full"
     35
     36# Using the PROJECT_BRIEF tag one can provide an optional one line description
     37# for a project that appears at the top of each page and should give viewer
     38# a quick idea about the purpose of the project. Keep the description short.
     39
     40PROJECT_BRIEF          =
     41
     42# With the PROJECT_LOGO tag one can specify an logo or icon that is
     43# included in the documentation. The maximum height of the logo should not
     44# exceed 55 pixels and the maximum width should not exceed 200 pixels.
     45# Doxygen will copy the logo to the output directory.
     46
     47PROJECT_LOGO           =
    3548
    3649# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     
    113126# the path. The tag can be used to show relative paths in the file list.
    114127# If left blank the directory from which doxygen is run is used as the
    115 # path to strip.
     128# path to strip. Note that you specify absolute paths here, but also
     129# relative paths, which will be relative from the directory where doxygen is
     130# started.
    116131
    117132STRIP_FROM_PATH        = ../src
     
    127142
    128143# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    129 # (but less readable) file names. This can be useful is your file systems
     144# (but less readable) file names. This can be useful if your file system
    130145# doesn't support long names like on DOS, Mac, or CD-ROM.
    131146
     
    182197ALIASES                =
    183198
     199# This tag can be used to specify a number of word-keyword mappings (TCL only).
     200# A mapping has the form "name=value". For example adding
     201# "class=itcl::class" will allow you to use the command class in the
     202# itcl::class meaning.
     203
     204TCL_SUBST              =
     205
    184206# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    185207# sources only. Doxygen will then generate output that is more tailored for C.
     
    208230OPTIMIZE_OUTPUT_VHDL   = NO
    209231
    210 # Doxygen selects the parser to use depending on the extension of the files it parses.
    211 # With this tag you can assign which parser to use for a given extension.
    212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
    213 # The format is ext=language, where ext is a file extension, and language is one of
    214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
    215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
    216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
    217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     232# Doxygen selects the parser to use depending on the extension of the files it
     233# parses. With this tag you can assign which parser to use for a given
     234# extension. Doxygen has a built-in mapping, but you can override or extend it
     235# using this tag. The format is ext=language, where ext is a file extension,
     236# and language is one of the parsers supported by doxygen: IDL, Java,
     237# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C,
     238# C++. For instance to make doxygen treat .inc files as Fortran files (default
     239# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note
     240# that for custom extensions you also need to set FILE_PATTERNS otherwise the
     241# files are not read by doxygen.
    218242
    219243EXTENSION_MAPPING      =
     244
     245# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
     246# comments according to the Markdown format, which allows for more readable
     247# documentation. See http://daringfireball.net/projects/markdown/ for details.
     248# The output of markdown processing is further processed by doxygen, so you
     249# can mix doxygen, HTML, and XML commands with Markdown formatting.
     250# Disable only in case of backward compatibilities issues.
     251
     252MARKDOWN_SUPPORT       = YES
     253
     254# When enabled doxygen tries to link words that correspond to documented classes,
     255# or namespaces to their corresponding documentation. Such a link can be
     256# prevented in individual cases by by putting a % sign in front of the word or
     257# globally by setting AUTOLINK_SUPPORT to NO.
     258
     259AUTOLINK_SUPPORT       = YES
    220260
    221261# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     
    223263# set this tag to YES in order to let doxygen match functions declarations and
    224264# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    225 # func(std::string) {}). This also make the inheritance and collaboration
     265# func(std::string) {}). This also makes the inheritance and collaboration
    226266# diagrams that involve STL classes more complete and accurate.
    227267
     
    239279SIP_SUPPORT            = NO
    240280
    241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    242 # and setter methods for a property. Setting this option to YES (the default)
    243 # will make doxygen to replace the get and set methods by a property in the
    244 # documentation. This will only work if the methods are indeed getting or
     281# For Microsoft's IDL there are propget and propput attributes to indicate
     282# getter and setter methods for a property. Setting this option to YES (the
     283# default) will make doxygen replace the get and set methods by a property in
     284# the documentation. This will only work if the methods are indeed getting or
    245285# setting a simple type. If this is not the case, or you want to show the
    246286# methods anyway, you should set this option to NO.
     
    262302
    263303SUBGROUPING            = YES
     304
     305# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
     306# unions are shown inside the group in which they are included (e.g. using
     307# @ingroup) instead of on a separate page (for HTML and Man pages) or
     308# section (for LaTeX and RTF).
     309
     310INLINE_GROUPED_CLASSES = NO
     311
     312# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
     313# unions with only public data fields will be shown inline in the documentation
     314# of the scope in which they are defined (i.e. file, namespace, or group
     315# documentation), provided this scope is documented. If set to NO (the default),
     316# structs, classes, and unions are shown on a separate page (for HTML and Man
     317# pages) or section (for LaTeX and RTF).
     318
     319INLINE_SIMPLE_STRUCTS  = NO
    264320
    265321# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     
    279335# probably good enough. For larger projects a too small cache size can cause
    280336# doxygen to be busy swapping symbols to and from disk most of the time
    281 # causing a significant performance penality.
     337# causing a significant performance penalty.
    282338# If the system has enough physical memory increasing the cache will improve the
    283339# performance by keeping more symbols in memory. Note that the value works on
    284 # a logarithmic scale so increasing the size by one will rougly double the
     340# a logarithmic scale so increasing the size by one will roughly double the
    285341# memory usage. The cache size is given by this formula:
    286342# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    287 # corresponding to a cache size of 2^16 = 65536 symbols
     343# corresponding to a cache size of 2^16 = 65536 symbols.
    288344
    289345SYMBOL_CACHE_SIZE      = 0
     346
     347# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
     348# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
     349# their name and scope. Since this can be an expensive process and often the
     350# same symbol appear multiple times in the code, doxygen keeps a cache of
     351# pre-resolved symbols. If the cache is too small doxygen will become slower.
     352# If the cache is too large, memory is wasted. The cache size is given by this
     353# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
     354# corresponding to a cache size of 2^16 = 65536 symbols.
     355
     356LOOKUP_CACHE_SIZE      = 0
    290357
    291358#---------------------------------------------------------------------------
     
    305372EXTRACT_PRIVATE        = YES
    306373
     374# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal
     375# scope will be included in the documentation.
     376
     377EXTRACT_PACKAGE        = NO
     378
    307379# If the EXTRACT_STATIC tag is set to YES all static members of a file
    308380# will be included in the documentation.
     
    327399# 'anonymous_namespace{file}', where file will be replaced with the base
    328400# name of the file that contains the anonymous namespace. By default
    329 # anonymous namespace are hidden.
     401# anonymous namespaces are hidden.
    330402
    331403EXTRACT_ANON_NSPACES   = NO
     
    373445# and Mac users are advised to set this option to NO.
    374446
    375 CASE_SENSE_NAMES       = YES
     447CASE_SENSE_NAMES       = NO
    376448
    377449# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     
    386458
    387459SHOW_INCLUDE_FILES     = YES
     460
     461# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
     462# will list include files with double quotes in the documentation
     463# rather than with sharp brackets.
     464
     465FORCE_LOCAL_INCLUDES   = NO
    388466
    389467# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     
    406484SORT_BRIEF_DOCS        = NO
    407485
    408 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     486# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
     487# will sort the (brief and detailed) documentation of class members so that
     488# constructors and destructors are listed first. If set to NO (the default)
     489# the constructors will appear in the respective orders defined by
     490# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
     491# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
     492# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
    409493
    410494SORT_MEMBERS_CTORS_1ST = NO
     
    426510SORT_BY_SCOPE_NAME     = NO
    427511
     512# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
     513# do proper type resolution of all parameters of a function it will reject a
     514# match between the prototype and the implementation of a member function even
     515# if there is only one candidate or it is obvious which candidate to choose
     516# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
     517# will still accept a match between prototype and implementation in such cases.
     518
     519STRICT_PROTO_MATCHING  = NO
     520
    428521# The GENERATE_TODOLIST tag can be used to enable (YES) or
    429522# disable (NO) the todo list. This list is created by putting \todo
     
    451544
    452545# The ENABLED_SECTIONS tag can be used to enable conditional
    453 # documentation sections, marked by \if sectionname ... \endif.
     546# documentation sections, marked by \if section-label ... \endif
     547# and \cond section-label ... \endcond blocks.
    454548
    455549ENABLED_SECTIONS       =
    456550
    457551# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    458 # the initial value of a variable or define consists of for it to appear in
     552# the initial value of a variable or macro consists of for it to appear in
    459553# the documentation. If the initializer consists of more lines than specified
    460554# here it will be hidden. Use a value of 0 to hide initializers completely.
    461 # The appearance of the initializer of individual variables and defines in the
     555# The appearance of the initializer of individual variables and macros in the
    462556# documentation can be controlled using \showinitializer or \hideinitializer
    463557# command in the documentation regardless of this setting.
     
    494588FILE_VERSION_FILTER    =
    495589
    496 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
    497 # doxygen. The layout file controls the global structure of the generated output files
    498 # in an output format independent way. The create the layout file that represents
    499 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
    500 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
    501 # of the layout file.
    502 
    503 LAYOUT_FILE            =
     590# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
     591# by doxygen. The layout file controls the global structure of the generated
     592# output files in an output format independent way. To create the layout file
     593# that represents doxygen's defaults, run doxygen with the -l option.
     594# You can optionally specify a file name after the option, if omitted
     595# DoxygenLayout.xml will be used as the name of the layout file.
     596
     597#LAYOUT_FILE            =
     598LAYOUT_FILE = DoxygenLayout.xml
     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         =
    504610
    505611#---------------------------------------------------------------------------
     
    531637WARN_IF_DOC_ERROR      = YES
    532638
    533 # This WARN_NO_PARAMDOC option can be abled to get warnings for
     639# The WARN_NO_PARAMDOC option can be enabled to get warnings for
    534640# functions that are documented, but have no documentation for their parameters
    535641# or return value. If set to NO (the default) doxygen will only warn about
     
    546652# be obtained via FILE_VERSION_FILTER)
    547653
    548 WARN_FORMAT            = "$file:$line: $text "
     654WARN_FORMAT            = "$file:$line: $text"
    549655
    550656# The WARN_LOGFILE tag can be used to specify a file to which warning
     
    577683# and *.h) to filter out the source-files in the directories. If left
    578684# blank the following patterns are tested:
    579 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
    580 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     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
    581688
    582689FILE_PATTERNS          = *.h *.c
     
    588695RECURSIVE              = YES
    589696
    590 # The EXCLUDE tag can be used to specify files and/or directories that should
     697# The EXCLUDE tag can be used to specify files and/or directories that should be
    591698# excluded from the INPUT source files. This way you can easily exclude a
    592699# 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.
    593702
    594703EXCLUDE                =
    595704
    596 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    597 # directories that are symbolic links (a Unix filesystem feature) are excluded
     705# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
     706# directories that are symbolic links (a Unix file system feature) are excluded
    598707# from the input.
    599708
     
    659768# The filters are a list of the form:
    660769# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    661 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    662 # is applied to all files.
     770# info on how filters are used. If FILTER_PATTERNS is empty or if
     771# non of the patterns match the file name, INPUT_FILTER is applied.
    663772
    664773FILTER_PATTERNS        =
     
    669778
    670779FILTER_SOURCE_FILES    = NO
     780
     781# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
     782# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
     783# and it is also possible to disable source filtering for a specific pattern
     784# using *.ext= (so without naming a filter). This option only has effect when
     785# FILTER_SOURCE_FILES is enabled.
     786
     787FILTER_SOURCE_PATTERNS =
     788
     789# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
     790# is part of the input, its contents will be placed on the main page (index.html).
     791# This can be useful if you have a project on for instance GitHub and want reuse
     792# the introduction page also for the doxygen output.
     793
     794USE_MDFILE_AS_MAINPAGE =
    671795
    672796#---------------------------------------------------------------------------
     
    688812# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    689813# doxygen to hide any special comment blocks from generated source code
    690 # fragments. Normal C and C++ comments will always remain visible.
     814# fragments. Normal C, C++ and Fortran comments will always remain visible.
    691815
    692816STRIP_CODE_COMMENTS    = NO
     
    772896# The HTML_HEADER tag can be used to specify a personal HTML header for
    773897# each generated HTML page. If it is left blank doxygen will generate a
    774 # standard header.
     898# standard header. Note that when using a custom header you are responsible
     899#  for the proper inclusion of any scripts and style sheets that doxygen
     900# needs, which is dependent on the configuration options used.
     901# It is advised to generate a default header using "doxygen -w html
     902# header.html footer.html stylesheet.css YourConfigFile" and then modify
     903# that header. Note that the header is subject to change so you typically
     904# have to redo this when upgrading to a newer version of doxygen or when
     905# changing the value of configuration settings such as GENERATE_TREEVIEW!
    775906
    776907HTML_HEADER            =
     
    784915# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    785916# style sheet that is used by each HTML page. It can be used to
    786 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    787 # will generate a default style sheet. Note that doxygen will try to copy
    788 # the style sheet file to the HTML output directory, so don't put your own
    789 # stylesheet in the HTML output directory as well, or it will be erased!
     917# fine-tune the look of the HTML output. If left blank doxygen will
     918# generate a default style sheet. Note that it is recommended to use
     919# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
     920# tag will in the future become obsolete.
    790921
    791922HTML_STYLESHEET        =
     923
     924# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
     925# user-defined cascading style sheet that is included after the standard
     926# style sheets created by doxygen. Using this option one can overrule
     927# certain style aspects. This is preferred over using HTML_STYLESHEET
     928# since it does not replace the standard style sheet and is therefor more
     929# robust against future updates. Doxygen will copy the style sheet file to
     930# the output directory.
     931
     932HTML_EXTRA_STYLESHEET  =
     933
     934# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
     935# other source files which should be copied to the HTML output directory. Note
     936# that these files will be copied to the base HTML output directory. Use the
     937# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     938# files. In the HTML_STYLESHEET file, use the file name only. Also note that
     939# the files will be copied as-is; there are no commands or markers available.
     940
     941HTML_EXTRA_FILES       =
     942
     943# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
     944# Doxygen will adjust the colors in the style sheet and background images
     945# according to this color. Hue is specified as an angle on a colorwheel,
     946# see http://en.wikipedia.org/wiki/Hue for more information.
     947# For instance the value 0 represents red, 60 is yellow, 120 is green,
     948# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
     949# The allowed range is 0 to 359.
     950
     951HTML_COLORSTYLE_HUE    = 220
     952
     953# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
     954# the colors in the HTML output. For a value of 0 the output will use
     955# grayscales only. A value of 255 will produce the most vivid colors.
     956
     957HTML_COLORSTYLE_SAT    = 100
     958
     959# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
     960# the luminance component of the colors in the HTML output. Values below
     961# 100 gradually make the output lighter, whereas values above 100 make
     962# the output darker. The value divided by 100 is the actual gamma applied,
     963# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
     964# and 100 does not change the gamma.
     965
     966HTML_COLORSTYLE_GAMMA  = 80
     967
     968# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
     969# page will contain the date and time when the page was generated. Setting
     970# this to NO can help when comparing the output of multiple runs.
     971
     972HTML_TIMESTAMP         = YES
    792973
    793974# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    794975# documentation will contain sections that can be hidden and shown after the
    795 # page has loaded. For this to work a browser that supports
    796 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    797 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     976# page has loaded.
    798977
    799978HTML_DYNAMIC_SECTIONS  = NO
     979
     980# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
     981# entries shown in the various tree structured indices initially; the user
     982# can expand and collapse entries dynamically later on. Doxygen will expand
     983# the tree to such a level that at most the specified number of entries are
     984# visible (unless a fully collapsed tree already exceeds this amount).
     985# So setting the number of entries 1 will produce a full collapsed tree by
     986# default. 0 is a special value representing an infinite number of entries
     987# and will result in a full expanded tree by default.
     988
     989HTML_INDEX_NUM_ENTRIES = 100
    800990
    801991# If the GENERATE_DOCSET tag is set to YES, additional index files
     
    807997# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    808998# it at startup.
    809 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     999# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1000# for more information.
    8101001
    8111002GENERATE_DOCSET        = NO
     
    8251016DOCSET_BUNDLE_ID       = org.doxygen.Project
    8261017
     1018# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
     1019# identify the documentation publisher. This should be a reverse domain-name
     1020# style string, e.g. com.mycompany.MyDocSet.documentation.
     1021
     1022DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
     1023
     1024# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
     1025
     1026DOCSET_PUBLISHER_NAME  = Publisher
     1027
    8271028# If the GENERATE_HTMLHELP tag is set to YES, additional index files
    8281029# will be generated that can be used as input for tools like the
     
    8691070TOC_EXPAND             = NO
    8701071
    871 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
    872 # are set, an additional index file will be generated that can be used as input for
    873 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
    874 # HTML documentation.
     1072# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
     1073# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
     1074# that can be used as input for Qt's qhelpgenerator to generate a
     1075# Qt Compressed Help (.qch) of the generated HTML documentation.
    8751076
    8761077GENERATE_QHP           = NO
     
    8941095QHP_VIRTUAL_FOLDER     = doc
    8951096
    896 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
    897 # For more information please see
     1097# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
     1098# add. For more information please see
    8981099# http://doc.trolltech.com/qthelpproject.html#custom-filters
    8991100
    9001101QHP_CUST_FILTER_NAME   =
    9011102
    902 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
    903 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     1103# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
     1104# custom filter to add. For more information please see
     1105# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
     1106# Qt Help Project / Custom Filters</a>.
    9041107
    9051108QHP_CUST_FILTER_ATTRS  =
    9061109
    907 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     1110# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
     1111# project's
    9081112# filter section matches.
    909 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     1113# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
     1114# Qt Help Project / Filter Attributes</a>.
    9101115
    9111116QHP_SECT_FILTER_ATTRS  =
     
    9181123QHG_LOCATION           =
    9191124
    920 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    921 # top of each HTML page. The value NO (the default) enables the index and
    922 # the value YES disables it.
     1125# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
     1126#  will be generated, which together with the HTML files, form an Eclipse help
     1127# plugin. To install this plugin and make it available under the help contents
     1128# menu in Eclipse, the contents of the directory containing the HTML and XML
     1129# files needs to be copied into the plugins directory of eclipse. The name of
     1130# the directory within the plugins directory should be the same as
     1131# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
     1132# the help appears.
     1133
     1134GENERATE_ECLIPSEHELP   = NO
     1135
     1136# A unique identifier for the eclipse help plugin. When installing the plugin
     1137# the directory name containing the HTML and XML files should also have
     1138# this name.
     1139
     1140ECLIPSE_DOC_ID         = org.doxygen.Project
     1141
     1142# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
     1143# at top of each HTML page. The value NO (the default) enables the index and
     1144# the value YES disables it. Since the tabs have the same information as the
     1145# navigation tree you can set this option to NO if you already set
     1146# GENERATE_TREEVIEW to YES.
    9231147
    9241148DISABLE_INDEX          = NO
    925 
    926 # This tag can be used to set the number of enum values (range [1..20])
    927 # that doxygen will group on one line in the generated HTML documentation.
    928 
    929 ENUM_VALUES_PER_LINE   = 4
    9301149
    9311150# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     
    9361155# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    9371156# Windows users are probably better off using the HTML help feature.
     1157# Since the tree basically has the same information as the tab index you
     1158# could consider to set DISABLE_INDEX to NO when enabling this option.
    9381159
    9391160GENERATE_TREEVIEW      = NO
     1161
     1162# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
     1163# (range [0,1..20]) that doxygen will group on one line in the generated HTML
     1164# documentation. Note that a value of 0 will completely suppress the enum
     1165# values from appearing in the overview section.
     1166
     1167ENUM_VALUES_PER_LINE   = 4
    9401168
    9411169# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     
    9441172
    9451173TREEVIEW_WIDTH         = 250
     1174
     1175# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
     1176# links to external symbols imported via tag files in a separate window.
     1177
     1178EXT_LINKS_IN_WINDOW    = NO
    9461179
    9471180# Use this tag to change the font size of Latex formulas included
     
    9531186FORMULA_FONTSIZE       = 10
    9541187
    955 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
    956 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
    957 # there is already a search function so this one should typically
    958 # be disabled.
     1188# Use the FORMULA_TRANPARENT tag to determine whether or not the images
     1189# generated for formulas are transparent PNGs. Transparent PNGs are
     1190# not supported properly for IE 6.0, but are supported on all modern browsers.
     1191# Note that when changing this option you need to delete any form_*.png files
     1192# in the HTML output before the changes have effect.
     1193
     1194FORMULA_TRANSPARENT    = YES
     1195
     1196# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
     1197# (see http://www.mathjax.org) which uses client side Javascript for the
     1198# rendering instead of using prerendered bitmaps. Use this if you do not
     1199# have LaTeX installed or if you want to formulas look prettier in the HTML
     1200# output. When enabled you may also need to install MathJax separately and
     1201# configure the path to it using the MATHJAX_RELPATH option.
     1202
     1203USE_MATHJAX            = YES
     1204
     1205# When MathJax is enabled you can set the default output format to be used for
     1206# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
     1207# SVG. The default value is HTML-CSS, which is slower, but has the best
     1208# compatibility.
     1209
     1210MATHJAX_FORMAT         = HTML-CSS
     1211
     1212# When MathJax is enabled you need to specify the location relative to the
     1213# HTML output directory using the MATHJAX_RELPATH option. The destination
     1214# directory should contain the MathJax.js script. For instance, if the mathjax
     1215# directory is located at the same level as the HTML output directory, then
     1216# MATHJAX_RELPATH should be ../mathjax. The default value points to
     1217# the MathJax Content Delivery Network so you can quickly see the result without
     1218# installing MathJax.
     1219# However, it is strongly recommended to install a local
     1220# copy of MathJax from http://www.mathjax.org before deployment.
     1221
     1222MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1223
     1224# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
     1225# names that should be enabled during MathJax rendering.
     1226
     1227MATHJAX_EXTENSIONS     =
     1228
     1229# When the SEARCHENGINE tag is enabled doxygen will generate a search box
     1230# for the HTML output. The underlying search engine uses javascript
     1231# and DHTML and should work on any modern browser. Note that when using
     1232# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
     1233# (GENERATE_DOCSET) there is already a search function so this one should
     1234# typically be disabled. For large projects the javascript based search engine
     1235# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
    9591236
    9601237SEARCHENGINE           = YES
     1238
     1239# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
     1240# implemented using a web server instead of a web client using Javascript.
     1241# There are two flavours of web server based search depending on the
     1242# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
     1243# searching and an index file used by the script. When EXTERNAL_SEARCH is
     1244# enabled the indexing and searching needs to be provided by external tools.
     1245# See the manual for details.
     1246
     1247SERVER_BASED_SEARCH    = NO
     1248
     1249# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
     1250# script for searching. Instead the search results are written to an XML file
     1251# which needs to be processed by an external indexer. Doxygen will invoke an
     1252# external search engine pointed to by the SEARCHENGINE_URL option to obtain
     1253# the search results. Doxygen ships with an example indexer (doxyindexer) and
     1254# search engine (doxysearch.cgi) which are based on the open source search engine
     1255# library Xapian. See the manual for configuration details.
     1256
     1257EXTERNAL_SEARCH        = NO
     1258
     1259# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     1260# which will returned the search results when EXTERNAL_SEARCH is enabled.
     1261# Doxygen ships with an example search engine (doxysearch) which is based on
     1262# the open source search engine library Xapian. See the manual for configuration
     1263# details.
     1264
     1265SEARCHENGINE_URL       =
     1266
     1267# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     1268# search data is written to a file for indexing by an external tool. With the
     1269# SEARCHDATA_FILE tag the name of this file can be specified.
     1270
     1271SEARCHDATA_FILE        = searchdata.xml
     1272
     1273# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
     1274# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
     1275# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
     1276# projects and redirect the results back to the right project.
     1277
     1278EXTERNAL_SEARCH_ID     =
     1279
     1280# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     1281# projects other than the one defined by this configuration file, but that are
     1282# all added to the same external search index. Each project needs to have a
     1283# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
     1284# of to a relative location where the documentation can be found.
     1285# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
     1286
     1287EXTRA_SEARCH_MAPPINGS  =
    9611288
    9621289#---------------------------------------------------------------------------
     
    9771304# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    9781305# invoked. If left blank `latex' will be used as the default command name.
     1306# Note that when enabling USE_PDFLATEX this option is only used for
     1307# generating bitmaps for formulas in the HTML output, but not in the
     1308# Makefile that is written to the output directory.
    9791309
    9801310LATEX_CMD_NAME         = latex
     
    9931323
    9941324# The PAPER_TYPE tag can be used to set the paper type that is used
    995 # by the printer. Possible values are: a4, a4wide, letter, legal and
     1325# by the printer. Possible values are: a4, letter, legal and
    9961326# executive. If left blank a4wide will be used.
    9971327
    998 PAPER_TYPE             = a4wide
     1328PAPER_TYPE             = a4
    9991329
    10001330# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
     
    10101340LATEX_HEADER           =
    10111341
     1342# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
     1343# the generated latex document. The footer should contain everything after
     1344# the last chapter. If it is left blank doxygen will generate a
     1345# standard footer. Notice: only use this tag if you know what you are doing!
     1346
     1347LATEX_FOOTER           =
     1348
    10121349# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    10131350# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     
    10151352# This makes the output suitable for online browsing using a pdf viewer.
    10161353
    1017 PDF_HYPERLINKS         = NO
     1354PDF_HYPERLINKS         = YES
    10181355
    10191356# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     
    10211358# higher quality PDF documentation.
    10221359
    1023 USE_PDFLATEX           = NO
     1360USE_PDFLATEX           = YES
    10241361
    10251362# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     
    10361373LATEX_HIDE_INDICES     = NO
    10371374
    1038 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
     1375# If LATEX_SOURCE_CODE is set to YES then doxygen will include
     1376# source code with syntax highlighting in the LaTeX output.
     1377# Note that which sources are shown also depends on other settings
     1378# such as SOURCE_BROWSER.
    10391379
    10401380LATEX_SOURCE_CODE      = NO
     1381
     1382# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
     1383# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
     1384# http://en.wikipedia.org/wiki/BibTeX for more info.
     1385
     1386LATEX_BIB_STYLE        = plain
    10411387
    10421388#---------------------------------------------------------------------------
     
    10711417RTF_HYPERLINKS         = NO
    10721418
    1073 # Load stylesheet definitions from file. Syntax is similar to doxygen's
     1419# Load style sheet definitions from file. Syntax is similar to doxygen's
    10741420# config file, i.e. a series of assignments. You only have to provide
    10751421# replacements, missing definitions are set to their default value.
     
    12161562
    12171563# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1218 # in the INCLUDE_PATH (see below) will be search if a #include is found.
     1564# pointed to by INCLUDE_PATH will be searched when a #include is found.
    12191565
    12201566SEARCH_INCLUDES        = YES
     
    12461592# this tag can be used to specify a list of macro names that should be expanded.
    12471593# The macro definition that is found in the sources will be used.
    1248 # Use the PREDEFINED tag if you want to use a different macro definition.
     1594# Use the PREDEFINED tag if you want to use a different macro definition that
     1595# overrules the definition found in the source code.
    12491596
    12501597EXPAND_AS_DEFINED      =
    12511598
    12521599# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1253 # doxygen's preprocessor will remove all function-like macros that are alone
    1254 # on a line, have an all uppercase name, and do not end with a semicolon. Such
    1255 # function macros are typically used for boiler-plate code, and will confuse
    1256 # the parser if not removed.
     1600# doxygen's preprocessor will remove all references to function-like macros
     1601# that are alone on a line, have an all uppercase name, and do not end with a
     1602# semicolon, because these will confuse the parser if not removed.
    12571603
    12581604SKIP_FUNCTION_MACROS   = YES
     
    12621608#---------------------------------------------------------------------------
    12631609
    1264 # The TAGFILES option can be used to specify one or more tagfiles.
    1265 # Optionally an initial location of the external documentation
    1266 # can be added for each tagfile. The format of a tag file without
    1267 # this location is as follows:
     1610# The TAGFILES option can be used to specify one or more tagfiles. For each
     1611# tag file the location of the external documentation should be added. The
     1612# format of a tag file without this location is as follows:
    12681613#
    12691614# TAGFILES = file1 file2 ...
     
    12711616#
    12721617# TAGFILES = file1=loc1 "file2 = loc2" ...
    1273 # where "loc1" and "loc2" can be relative or absolute paths or
    1274 # URLs. If a location is present for each tag, the installdox tool
    1275 # does not have to be run to correct the links.
    1276 # Note that each tag file must have a unique name
    1277 # (where the name does NOT include the path)
    1278 # If a tag file is not located in the directory in which doxygen
    1279 # is run, you must also specify the path to the tagfile here.
     1618# where "loc1" and "loc2" can be relative or absolute paths
     1619# or URLs. Note that each tag file must have a unique name (where the name does
     1620# NOT include the path). If a tag file is not located in the directory in which
     1621# doxygen is run, you must also specify the path to the tagfile here.
    12801622
    12811623TAGFILES               =
     
    13101652# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    13111653# or super classes. Setting the tag to NO turns the diagrams off. Note that
    1312 # this option is superseded by the HAVE_DOT option below. This is only a
    1313 # fallback. It is recommended to install and use dot, since it yields more
    1314 # powerful graphs.
     1654# this option also works with HAVE_DOT disabled, but it is recommended to
     1655# install and use dot, since it yields more powerful graphs.
    13151656
    13161657CLASS_DIAGRAMS         = YES
     
    13361677# have no effect if this option is set to NO (the default)
    13371678
    1338 HAVE_DOT               = YES
    1339 
    1340 # By default doxygen will write a font called FreeSans.ttf to the output
    1341 # directory and reference it in all dot files that doxygen generates. This
    1342 # font does not include all possible unicode characters however, so when you need
    1343 # these (or just want a differently looking font) you can specify the font name
    1344 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
    1345 # which can be done by putting it in a standard location or by setting the
    1346 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
    1347 # containing the font.
     1679HAVE_DOT               = NO
     1680
     1681# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
     1682# allowed to run in parallel. When set to 0 (the default) doxygen will
     1683# base this on the number of processors available in the system. You can set it
     1684# explicitly to a value larger than 0 to get control over the balance
     1685# between CPU load and processing speed.
     1686
     1687DOT_NUM_THREADS        = 0
     1688
     1689# By default doxygen will use the Helvetica font for all dot files that
     1690# doxygen generates. When you want a differently looking font you can specify
     1691# the font name using DOT_FONTNAME. You need to make sure dot is able to find
     1692# the font, which can be done by putting it in a standard location or by setting
     1693# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
     1694# directory containing the font.
    13481695
    13491696DOT_FONTNAME           = FreeSans
     
    13541701DOT_FONTSIZE           = 10
    13551702
    1356 # By default doxygen will tell dot to use the output directory to look for the
    1357 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
    1358 # different font using DOT_FONTNAME you can set the path where dot
    1359 # can find it using this tag.
     1703# By default doxygen will tell dot to use the Helvetica font.
     1704# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
     1705# set the path where dot can find it.
    13601706
    13611707DOT_FONTPATH           =
     
    13641710# will generate a graph for each documented class showing the direct and
    13651711# indirect inheritance relations. Setting this tag to YES will force the
    1366 # the CLASS_DIAGRAMS tag to NO.
     1712# CLASS_DIAGRAMS tag to NO.
    13671713
    13681714CLASS_GRAPH            = YES
     
    13851731
    13861732UML_LOOK               = NO
     1733
     1734# If the UML_LOOK tag is enabled, the fields and methods are shown inside
     1735# the class node. If there are many fields or methods and many nodes the
     1736# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
     1737# threshold limits the number of items for each type to make the size more
     1738# managable. Set this to 0 for no limit. Note that the threshold may be
     1739# exceeded by 50% before the limit is enforced.
     1740
     1741UML_LIMIT_NUM_FIELDS   = 10
    13871742
    13881743# If set to YES, the inheritance and collaboration graphs will show the
     
    14221777
    14231778# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1424 # will graphical hierarchy of all classes instead of a textual one.
     1779# will generate a graphical hierarchy of all classes instead of a textual one.
    14251780
    14261781GRAPHICAL_HIERARCHY    = YES
    14271782
    1428 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1783# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
    14291784# then doxygen will show the dependencies a directory has on other directories
    14301785# in a graphical way. The dependency relations are determined by the #include
     
    14341789
    14351790# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1436 # generated by dot. Possible values are png, jpg, or gif
    1437 # If left blank png will be used.
     1791# generated by dot. Possible values are svg, png, jpg, or gif.
     1792# If left blank png will be used. If you choose svg you need to set
     1793# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
     1794# visible in IE 9+ (other browsers do not have this requirement).
    14381795
    14391796DOT_IMAGE_FORMAT       = png
     1797
     1798# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
     1799# enable generation of interactive SVG images that allow zooming and panning.
     1800# Note that this requires a modern browser other than Internet Explorer.
     1801# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
     1802# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
     1803# visible. Older versions of IE do not have SVG support.
     1804
     1805INTERACTIVE_SVG        = NO
    14401806
    14411807# The tag DOT_PATH can be used to specify the path where the dot tool can be
     
    14491815
    14501816DOTFILE_DIRS           =
     1817
     1818# The MSCFILE_DIRS tag can be used to specify one or more directories that
     1819# contain msc files that are included in the documentation (see the
     1820# \mscfile command).
     1821
     1822MSCFILE_DIRS           =
    14511823
    14521824# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  • doc/web.cfg

    rac20c85 rbb42f65  
    1 # Doxyfile 1.6.1
     1# Doxyfile 1.8.3.1
    22
    33# This file describes the settings to be used by the documentation system
    4 # doxygen (www.doxygen.org) for a project
     4# doxygen (www.doxygen.org) for a project.
    55#
    6 # All text after a hash (#) is considered a comment and will be ignored
     6# All text after a hash (#) is considered a comment and will be ignored.
    77# The format is:
    88#       TAG = value [value, ...]
    99# For lists items can also be appended using:
    1010#       TAG += value [value, ...]
    11 # Values that contain spaces should be placed between quotes (" ")
     11# Values that contain spaces should be placed between quotes (" ").
    1212
    1313#---------------------------------------------------------------------------
     
    2323DOXYFILE_ENCODING      = UTF-8
    2424
    25 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
    26 # by quotes) that should identify the project.
     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.
    2728
    2829PROJECT_NAME           = aubio
     
    3334
    3435PROJECT_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           =
    3549
    3650# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
     
    113127# the path. The tag can be used to show relative paths in the file list.
    114128# If left blank the directory from which doxygen is run is used as the
    115 # path to strip.
     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.
    116132
    117133STRIP_FROM_PATH        = ../src
     
    127143
    128144# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
    129 # (but less readable) file names. This can be useful is your file systems
     145# (but less readable) file names. This can be useful if your file system
    130146# doesn't support long names like on DOS, Mac, or CD-ROM.
    131147
     
    182198ALIASES                =
    183199
     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
    184207# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
    185208# sources only. Doxygen will then generate output that is more tailored for C.
     
    208231OPTIMIZE_OUTPUT_VHDL   = NO
    209232
    210 # Doxygen selects the parser to use depending on the extension of the files it parses.
    211 # With this tag you can assign which parser to use for a given extension.
    212 # Doxygen has a built-in mapping, but you can override or extend it using this tag.
    213 # The format is ext=language, where ext is a file extension, and language is one of
    214 # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP,
    215 # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat
    216 # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran),
    217 # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
     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.
    218243
    219244EXTENSION_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
    220261
    221262# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
     
    223264# set this tag to YES in order to let doxygen match functions declarations and
    224265# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
    225 # func(std::string) {}). This also make the inheritance and collaboration
     266# func(std::string) {}). This also makes the inheritance and collaboration
    226267# diagrams that involve STL classes more complete and accurate.
    227268
     
    239280SIP_SUPPORT            = NO
    240281
    241 # For Microsoft's IDL there are propget and propput attributes to indicate getter
    242 # and setter methods for a property. Setting this option to YES (the default)
    243 # will make doxygen to replace the get and set methods by a property in the
    244 # documentation. This will only work if the methods are indeed getting or
     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
    245286# setting a simple type. If this is not the case, or you want to show the
    246287# methods anyway, you should set this option to NO.
     
    262303
    263304SUBGROUPING            = 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
    264321
    265322# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
     
    279336# probably good enough. For larger projects a too small cache size can cause
    280337# doxygen to be busy swapping symbols to and from disk most of the time
    281 # causing a significant performance penality.
     338# causing a significant performance penalty.
    282339# If the system has enough physical memory increasing the cache will improve the
    283340# performance by keeping more symbols in memory. Note that the value works on
    284 # a logarithmic scale so increasing the size by one will rougly double the
     341# a logarithmic scale so increasing the size by one will roughly double the
    285342# memory usage. The cache size is given by this formula:
    286343# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
    287 # corresponding to a cache size of 2^16 = 65536 symbols
     344# corresponding to a cache size of 2^16 = 65536 symbols.
    288345
    289346SYMBOL_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
    290358
    291359#---------------------------------------------------------------------------
     
    305373EXTRACT_PRIVATE        = NO
    306374
     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
    307380# If the EXTRACT_STATIC tag is set to YES all static members of a file
    308381# will be included in the documentation.
     
    327400# 'anonymous_namespace{file}', where file will be replaced with the base
    328401# name of the file that contains the anonymous namespace. By default
    329 # anonymous namespace are hidden.
     402# anonymous namespaces are hidden.
    330403
    331404EXTRACT_ANON_NSPACES   = NO
     
    373446# and Mac users are advised to set this option to NO.
    374447
    375 CASE_SENSE_NAMES       = YES
     448CASE_SENSE_NAMES       = NO
    376449
    377450# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
     
    386459
    387460SHOW_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
    388467
    389468# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
     
    406485SORT_BRIEF_DOCS        = NO
    407486
    408 # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
     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.
    409494
    410495SORT_MEMBERS_CTORS_1ST = NO
     
    426511SORT_BY_SCOPE_NAME     = NO
    427512
     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
    428522# The GENERATE_TODOLIST tag can be used to enable (YES) or
    429523# disable (NO) the todo list. This list is created by putting \todo
     
    451545
    452546# The ENABLED_SECTIONS tag can be used to enable conditional
    453 # documentation sections, marked by \if sectionname ... \endif.
     547# documentation sections, marked by \if section-label ... \endif
     548# and \cond section-label ... \endcond blocks.
    454549
    455550ENABLED_SECTIONS       =
    456551
    457552# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
    458 # the initial value of a variable or define consists of for it to appear in
     553# the initial value of a variable or macro consists of for it to appear in
    459554# the documentation. If the initializer consists of more lines than specified
    460555# here it will be hidden. Use a value of 0 to hide initializers completely.
    461 # The appearance of the initializer of individual variables and defines in the
     556# The appearance of the initializer of individual variables and macros in the
    462557# documentation can be controlled using \showinitializer or \hideinitializer
    463558# command in the documentation regardless of this setting.
     
    494589FILE_VERSION_FILTER    =
    495590
    496 # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by
    497 # doxygen. The layout file controls the global structure of the generated output files
    498 # in an output format independent way. The create the layout file that represents
    499 # doxygen's defaults, run doxygen with the -l option. You can optionally specify a
    500 # file name after the option, if omitted DoxygenLayout.xml will be used as the name
    501 # of the layout file.
    502 
    503 LAYOUT_FILE            =
     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
     598#LAYOUT_FILE            =
     599LAYOUT_FILE = DoxygenLayout.xml
     600
     601# The CITE_BIB_FILES tag can be used to specify one or more bib files
     602# containing the references data. This must be a list of .bib files. The
     603# .bib extension is automatically appended if omitted. Using this command
     604# requires the bibtex tool to be installed. See also
     605# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
     606# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
     607# feature you need bibtex and perl available in the search path. Do not use
     608# file names with spaces, bibtex cannot handle them.
     609
     610CITE_BIB_FILES         =
    504611
    505612#---------------------------------------------------------------------------
     
    531638WARN_IF_DOC_ERROR      = YES
    532639
    533 # This WARN_NO_PARAMDOC option can be abled to get warnings for
     640# The WARN_NO_PARAMDOC option can be enabled to get warnings for
    534641# functions that are documented, but have no documentation for their parameters
    535642# or return value. If set to NO (the default) doxygen will only warn about
     
    546653# be obtained via FILE_VERSION_FILTER)
    547654
    548 WARN_FORMAT            = "$file:$line: $text "
     655WARN_FORMAT            = "$file:$line: $text"
    549656
    550657# The WARN_LOGFILE tag can be used to specify a file to which warning
     
    577684# and *.h) to filter out the source-files in the directories. If left
    578685# blank the following patterns are tested:
    579 # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
    580 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
     686# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
     687# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
     688# *.f90 *.f *.for *.vhd *.vhdl
    581689
    582690FILE_PATTERNS          = *.h
     
    588696RECURSIVE              = YES
    589697
    590 # The EXCLUDE tag can be used to specify files and/or directories that should
     698# The EXCLUDE tag can be used to specify files and/or directories that should be
    591699# excluded from the INPUT source files. This way you can easily exclude a
    592700# subdirectory from a directory tree whose root is specified with the INPUT tag.
     701# Note that relative paths are relative to the directory from which doxygen is
     702# run.
    593703
    594704EXCLUDE                = ../src/aubio_priv.h \
     
    609719                         ../src/utils.h
    610720
    611 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
    612 # directories that are symbolic links (a Unix filesystem feature) are excluded
     721# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
     722# directories that are symbolic links (a Unix file system feature) are excluded
    613723# from the input.
    614724
     
    674784# The filters are a list of the form:
    675785# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
    676 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER
    677 # is applied to all files.
     786# info on how filters are used. If FILTER_PATTERNS is empty or if
     787# non of the patterns match the file name, INPUT_FILTER is applied.
    678788
    679789FILTER_PATTERNS        =
     
    684794
    685795FILTER_SOURCE_FILES    = NO
     796
     797# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
     798# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
     799# and it is also possible to disable source filtering for a specific pattern
     800# using *.ext= (so without naming a filter). This option only has effect when
     801# FILTER_SOURCE_FILES is enabled.
     802
     803FILTER_SOURCE_PATTERNS =
     804
     805# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that
     806# is part of the input, its contents will be placed on the main page (index.html).
     807# This can be useful if you have a project on for instance GitHub and want reuse
     808# the introduction page also for the doxygen output.
     809
     810USE_MDFILE_AS_MAINPAGE =
    686811
    687812#---------------------------------------------------------------------------
     
    703828# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
    704829# doxygen to hide any special comment blocks from generated source code
    705 # fragments. Normal C and C++ comments will always remain visible.
     830# fragments. Normal C, C++ and Fortran comments will always remain visible.
    706831
    707832STRIP_CODE_COMMENTS    = NO
     
    787912# The HTML_HEADER tag can be used to specify a personal HTML header for
    788913# each generated HTML page. If it is left blank doxygen will generate a
    789 # standard header.
     914# standard header. Note that when using a custom header you are responsible
     915#  for the proper inclusion of any scripts and style sheets that doxygen
     916# needs, which is dependent on the configuration options used.
     917# It is advised to generate a default header using "doxygen -w html
     918# header.html footer.html stylesheet.css YourConfigFile" and then modify
     919# that header. Note that the header is subject to change so you typically
     920# have to redo this when upgrading to a newer version of doxygen or when
     921# changing the value of configuration settings such as GENERATE_TREEVIEW!
    790922
    791923HTML_HEADER            =
     
    799931# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
    800932# style sheet that is used by each HTML page. It can be used to
    801 # fine-tune the look of the HTML output. If the tag is left blank doxygen
    802 # will generate a default style sheet. Note that doxygen will try to copy
    803 # the style sheet file to the HTML output directory, so don't put your own
    804 # stylesheet in the HTML output directory as well, or it will be erased!
     933# fine-tune the look of the HTML output. If left blank doxygen will
     934# generate a default style sheet. Note that it is recommended to use
     935# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this
     936# tag will in the future become obsolete.
    805937
    806938HTML_STYLESHEET        =
     939
     940# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional
     941# user-defined cascading style sheet that is included after the standard
     942# style sheets created by doxygen. Using this option one can overrule
     943# certain style aspects. This is preferred over using HTML_STYLESHEET
     944# since it does not replace the standard style sheet and is therefor more
     945# robust against future updates. Doxygen will copy the style sheet file to
     946# the output directory.
     947
     948HTML_EXTRA_STYLESHEET  =
     949
     950# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
     951# other source files which should be copied to the HTML output directory. Note
     952# that these files will be copied to the base HTML output directory. Use the
     953# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
     954# files. In the HTML_STYLESHEET file, use the file name only. Also note that
     955# the files will be copied as-is; there are no commands or markers available.
     956
     957HTML_EXTRA_FILES       =
     958
     959# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
     960# Doxygen will adjust the colors in the style sheet and background images
     961# according to this color. Hue is specified as an angle on a colorwheel,
     962# see http://en.wikipedia.org/wiki/Hue for more information.
     963# For instance the value 0 represents red, 60 is yellow, 120 is green,
     964# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
     965# The allowed range is 0 to 359.
     966
     967HTML_COLORSTYLE_HUE    = 220
     968
     969# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
     970# the colors in the HTML output. For a value of 0 the output will use
     971# grayscales only. A value of 255 will produce the most vivid colors.
     972
     973HTML_COLORSTYLE_SAT    = 100
     974
     975# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
     976# the luminance component of the colors in the HTML output. Values below
     977# 100 gradually make the output lighter, whereas values above 100 make
     978# the output darker. The value divided by 100 is the actual gamma applied,
     979# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
     980# and 100 does not change the gamma.
     981
     982HTML_COLORSTYLE_GAMMA  = 80
     983
     984# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
     985# page will contain the date and time when the page was generated. Setting
     986# this to NO can help when comparing the output of multiple runs.
     987
     988HTML_TIMESTAMP         = YES
    807989
    808990# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
    809991# documentation will contain sections that can be hidden and shown after the
    810 # page has loaded. For this to work a browser that supports
    811 # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
    812 # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
     992# page has loaded.
    813993
    814994HTML_DYNAMIC_SECTIONS  = NO
     995
     996# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of
     997# entries shown in the various tree structured indices initially; the user
     998# can expand and collapse entries dynamically later on. Doxygen will expand
     999# the tree to such a level that at most the specified number of entries are
     1000# visible (unless a fully collapsed tree already exceeds this amount).
     1001# So setting the number of entries 1 will produce a full collapsed tree by
     1002# default. 0 is a special value representing an infinite number of entries
     1003# and will result in a full expanded tree by default.
     1004
     1005HTML_INDEX_NUM_ENTRIES = 100
    8151006
    8161007# If the GENERATE_DOCSET tag is set to YES, additional index files
     
    8221013# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
    8231014# it at startup.
    824 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
     1015# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
     1016# for more information.
    8251017
    8261018GENERATE_DOCSET        = NO
     
    8401032DOCSET_BUNDLE_ID       = org.doxygen.Project
    8411033
     1034# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely
     1035# identify the documentation publisher. This should be a reverse domain-name
     1036# style string, e.g. com.mycompany.MyDocSet.documentation.
     1037
     1038DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
     1039
     1040# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
     1041
     1042DOCSET_PUBLISHER_NAME  = Publisher
     1043
    8421044# If the GENERATE_HTMLHELP tag is set to YES, additional index files
    8431045# will be generated that can be used as input for tools like the
     
    8841086TOC_EXPAND             = NO
    8851087
    886 # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER
    887 # are set, an additional index file will be generated that can be used as input for
    888 # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated
    889 # HTML documentation.
     1088# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
     1089# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
     1090# that can be used as input for Qt's qhelpgenerator to generate a
     1091# Qt Compressed Help (.qch) of the generated HTML documentation.
    8901092
    8911093GENERATE_QHP           = NO
     
    9091111QHP_VIRTUAL_FOLDER     = doc
    9101112
    911 # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add.
    912 # For more information please see
     1113# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
     1114# add. For more information please see
    9131115# http://doc.trolltech.com/qthelpproject.html#custom-filters
    9141116
    9151117QHP_CUST_FILTER_NAME   =
    9161118
    917 # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see
    918 # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>.
     1119# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
     1120# custom filter to add. For more information please see
     1121# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
     1122# Qt Help Project / Custom Filters</a>.
    9191123
    9201124QHP_CUST_FILTER_ATTRS  =
    9211125
    922 # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's
     1126# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
     1127# project's
    9231128# filter section matches.
    924 # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>.
     1129# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
     1130# Qt Help Project / Filter Attributes</a>.
    9251131
    9261132QHP_SECT_FILTER_ATTRS  =
     
    9331139QHG_LOCATION           =
    9341140
    935 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
    936 # top of each HTML page. The value NO (the default) enables the index and
    937 # the value YES disables it.
     1141# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
     1142#  will be generated, which together with the HTML files, form an Eclipse help
     1143# plugin. To install this plugin and make it available under the help contents
     1144# menu in Eclipse, the contents of the directory containing the HTML and XML
     1145# files needs to be copied into the plugins directory of eclipse. The name of
     1146# the directory within the plugins directory should be the same as
     1147# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
     1148# the help appears.
     1149
     1150GENERATE_ECLIPSEHELP   = NO
     1151
     1152# A unique identifier for the eclipse help plugin. When installing the plugin
     1153# the directory name containing the HTML and XML files should also have
     1154# this name.
     1155
     1156ECLIPSE_DOC_ID         = org.doxygen.Project
     1157
     1158# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
     1159# at top of each HTML page. The value NO (the default) enables the index and
     1160# the value YES disables it. Since the tabs have the same information as the
     1161# navigation tree you can set this option to NO if you already set
     1162# GENERATE_TREEVIEW to YES.
    9381163
    9391164DISABLE_INDEX          = NO
    940 
    941 # This tag can be used to set the number of enum values (range [1..20])
    942 # that doxygen will group on one line in the generated HTML documentation.
    943 
    944 ENUM_VALUES_PER_LINE   = 4
    9451165
    9461166# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
     
    9511171# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
    9521172# Windows users are probably better off using the HTML help feature.
     1173# Since the tree basically has the same information as the tab index you
     1174# could consider to set DISABLE_INDEX to NO when enabling this option.
    9531175
    9541176GENERATE_TREEVIEW      = NO
     1177
     1178# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
     1179# (range [0,1..20]) that doxygen will group on one line in the generated HTML
     1180# documentation. Note that a value of 0 will completely suppress the enum
     1181# values from appearing in the overview section.
     1182
     1183ENUM_VALUES_PER_LINE   = 4
    9551184
    9561185# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
     
    9591188
    9601189TREEVIEW_WIDTH         = 250
     1190
     1191# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
     1192# links to external symbols imported via tag files in a separate window.
     1193
     1194EXT_LINKS_IN_WINDOW    = NO
    9611195
    9621196# Use this tag to change the font size of Latex formulas included
     
    9681202FORMULA_FONTSIZE       = 10
    9691203
    970 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript
    971 # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP)
    972 # there is already a search function so this one should typically
    973 # be disabled.
     1204# Use the FORMULA_TRANPARENT tag to determine whether or not the images
     1205# generated for formulas are transparent PNGs. Transparent PNGs are
     1206# not supported properly for IE 6.0, but are supported on all modern browsers.
     1207# Note that when changing this option you need to delete any form_*.png files
     1208# in the HTML output before the changes have effect.
     1209
     1210FORMULA_TRANSPARENT    = YES
     1211
     1212# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
     1213# (see http://www.mathjax.org) which uses client side Javascript for the
     1214# rendering instead of using prerendered bitmaps. Use this if you do not
     1215# have LaTeX installed or if you want to formulas look prettier in the HTML
     1216# output. When enabled you may also need to install MathJax separately and
     1217# configure the path to it using the MATHJAX_RELPATH option.
     1218
     1219USE_MATHJAX            = YES
     1220
     1221# When MathJax is enabled you can set the default output format to be used for
     1222# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and
     1223# SVG. The default value is HTML-CSS, which is slower, but has the best
     1224# compatibility.
     1225
     1226MATHJAX_FORMAT         = HTML-CSS
     1227
     1228# When MathJax is enabled you need to specify the location relative to the
     1229# HTML output directory using the MATHJAX_RELPATH option. The destination
     1230# directory should contain the MathJax.js script. For instance, if the mathjax
     1231# directory is located at the same level as the HTML output directory, then
     1232# MATHJAX_RELPATH should be ../mathjax. The default value points to
     1233# the MathJax Content Delivery Network so you can quickly see the result without
     1234# installing MathJax.
     1235# However, it is strongly recommended to install a local
     1236# copy of MathJax from http://www.mathjax.org before deployment.
     1237
     1238MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1239
     1240# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
     1241# names that should be enabled during MathJax rendering.
     1242
     1243MATHJAX_EXTENSIONS     =
     1244
     1245# When the SEARCHENGINE tag is enabled doxygen will generate a search box
     1246# for the HTML output. The underlying search engine uses javascript
     1247# and DHTML and should work on any modern browser. Note that when using
     1248# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
     1249# (GENERATE_DOCSET) there is already a search function so this one should
     1250# typically be disabled. For large projects the javascript based search engine
     1251# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
    9741252
    9751253SEARCHENGINE           = YES
     1254
     1255# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
     1256# implemented using a web server instead of a web client using Javascript.
     1257# There are two flavours of web server based search depending on the
     1258# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
     1259# searching and an index file used by the script. When EXTERNAL_SEARCH is
     1260# enabled the indexing and searching needs to be provided by external tools.
     1261# See the manual for details.
     1262
     1263SERVER_BASED_SEARCH    = NO
     1264
     1265# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP
     1266# script for searching. Instead the search results are written to an XML file
     1267# which needs to be processed by an external indexer. Doxygen will invoke an
     1268# external search engine pointed to by the SEARCHENGINE_URL option to obtain
     1269# the search results. Doxygen ships with an example indexer (doxyindexer) and
     1270# search engine (doxysearch.cgi) which are based on the open source search engine
     1271# library Xapian. See the manual for configuration details.
     1272
     1273EXTERNAL_SEARCH        = NO
     1274
     1275# The SEARCHENGINE_URL should point to a search engine hosted by a web server
     1276# which will returned the search results when EXTERNAL_SEARCH is enabled.
     1277# Doxygen ships with an example search engine (doxysearch) which is based on
     1278# the open source search engine library Xapian. See the manual for configuration
     1279# details.
     1280
     1281SEARCHENGINE_URL       =
     1282
     1283# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
     1284# search data is written to a file for indexing by an external tool. With the
     1285# SEARCHDATA_FILE tag the name of this file can be specified.
     1286
     1287SEARCHDATA_FILE        = searchdata.xml
     1288
     1289# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the
     1290# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
     1291# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
     1292# projects and redirect the results back to the right project.
     1293
     1294EXTERNAL_SEARCH_ID     =
     1295
     1296# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
     1297# projects other than the one defined by this configuration file, but that are
     1298# all added to the same external search index. Each project needs to have a
     1299# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id
     1300# of to a relative location where the documentation can be found.
     1301# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ...
     1302
     1303EXTRA_SEARCH_MAPPINGS  =
    9761304
    9771305#---------------------------------------------------------------------------
     
    9921320# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
    9931321# invoked. If left blank `latex' will be used as the default command name.
     1322# Note that when enabling USE_PDFLATEX this option is only used for
     1323# generating bitmaps for formulas in the HTML output, but not in the
     1324# Makefile that is written to the output directory.
    9941325
    9951326LATEX_CMD_NAME         = latex
     
    10081339
    10091340# The PAPER_TYPE tag can be used to set the paper type that is used
    1010 # by the printer. Possible values are: a4, a4wide, letter, legal and
     1341# by the printer. Possible values are: a4, letter, legal and
    10111342# executive. If left blank a4wide will be used.
    10121343
    1013 PAPER_TYPE             = a4wide
     1344PAPER_TYPE             = a4
    10141345
    10151346# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
     
    10251356LATEX_HEADER           =
    10261357
     1358# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
     1359# the generated latex document. The footer should contain everything after
     1360# the last chapter. If it is left blank doxygen will generate a
     1361# standard footer. Notice: only use this tag if you know what you are doing!
     1362
     1363LATEX_FOOTER           =
     1364
    10271365# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
    10281366# is prepared for conversion to pdf (using ps2pdf). The pdf file will
     
    10301368# This makes the output suitable for online browsing using a pdf viewer.
    10311369
    1032 PDF_HYPERLINKS         = NO
     1370PDF_HYPERLINKS         = YES
    10331371
    10341372# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
     
    10361374# higher quality PDF documentation.
    10371375
    1038 USE_PDFLATEX           = NO
     1376USE_PDFLATEX           = YES
    10391377
    10401378# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
     
    10511389LATEX_HIDE_INDICES     = NO
    10521390
    1053 # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
     1391# If LATEX_SOURCE_CODE is set to YES then doxygen will include
     1392# source code with syntax highlighting in the LaTeX output.
     1393# Note that which sources are shown also depends on other settings
     1394# such as SOURCE_BROWSER.
    10541395
    10551396LATEX_SOURCE_CODE      = NO
     1397
     1398# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
     1399# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
     1400# http://en.wikipedia.org/wiki/BibTeX for more info.
     1401
     1402LATEX_BIB_STYLE        = plain
    10561403
    10571404#---------------------------------------------------------------------------
     
    10861433RTF_HYPERLINKS         = NO
    10871434
    1088 # Load stylesheet definitions from file. Syntax is similar to doxygen's
     1435# Load style sheet definitions from file. Syntax is similar to doxygen's
    10891436# config file, i.e. a series of assignments. You only have to provide
    10901437# replacements, missing definitions are set to their default value.
     
    12311578
    12321579# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
    1233 # in the INCLUDE_PATH (see below) will be search if a #include is found.
     1580# pointed to by INCLUDE_PATH will be searched when a #include is found.
    12341581
    12351582SEARCH_INCLUDES        = YES
     
    12611608# this tag can be used to specify a list of macro names that should be expanded.
    12621609# The macro definition that is found in the sources will be used.
    1263 # Use the PREDEFINED tag if you want to use a different macro definition.
     1610# Use the PREDEFINED tag if you want to use a different macro definition that
     1611# overrules the definition found in the source code.
    12641612
    12651613EXPAND_AS_DEFINED      =
    12661614
    12671615# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
    1268 # doxygen's preprocessor will remove all function-like macros that are alone
    1269 # on a line, have an all uppercase name, and do not end with a semicolon. Such
    1270 # function macros are typically used for boiler-plate code, and will confuse
    1271 # the parser if not removed.
     1616# doxygen's preprocessor will remove all references to function-like macros
     1617# that are alone on a line, have an all uppercase name, and do not end with a
     1618# semicolon, because these will confuse the parser if not removed.
    12721619
    12731620SKIP_FUNCTION_MACROS   = YES
     
    12771624#---------------------------------------------------------------------------
    12781625
    1279 # The TAGFILES option can be used to specify one or more tagfiles.
    1280 # Optionally an initial location of the external documentation
    1281 # can be added for each tagfile. The format of a tag file without
    1282 # this location is as follows:
     1626# The TAGFILES option can be used to specify one or more tagfiles. For each
     1627# tag file the location of the external documentation should be added. The
     1628# format of a tag file without this location is as follows:
    12831629#
    12841630# TAGFILES = file1 file2 ...
     
    12861632#
    12871633# TAGFILES = file1=loc1 "file2 = loc2" ...
    1288 # where "loc1" and "loc2" can be relative or absolute paths or
    1289 # URLs. If a location is present for each tag, the installdox tool
    1290 # does not have to be run to correct the links.
    1291 # Note that each tag file must have a unique name
    1292 # (where the name does NOT include the path)
    1293 # If a tag file is not located in the directory in which doxygen
    1294 # is run, you must also specify the path to the tagfile here.
     1634# where "loc1" and "loc2" can be relative or absolute paths
     1635# or URLs. Note that each tag file must have a unique name (where the name does
     1636# NOT include the path). If a tag file is not located in the directory in which
     1637# doxygen is run, you must also specify the path to the tagfile here.
    12951638
    12961639TAGFILES               =
     
    13251668# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
    13261669# or super classes. Setting the tag to NO turns the diagrams off. Note that
    1327 # this option is superseded by the HAVE_DOT option below. This is only a
    1328 # fallback. It is recommended to install and use dot, since it yields more
    1329 # powerful graphs.
     1670# this option also works with HAVE_DOT disabled, but it is recommended to
     1671# install and use dot, since it yields more powerful graphs.
    13301672
    13311673CLASS_DIAGRAMS         = YES
     
    13511693# have no effect if this option is set to NO (the default)
    13521694
    1353 HAVE_DOT               = YES
    1354 
    1355 # By default doxygen will write a font called FreeSans.ttf to the output
    1356 # directory and reference it in all dot files that doxygen generates. This
    1357 # font does not include all possible unicode characters however, so when you need
    1358 # these (or just want a differently looking font) you can specify the font name
    1359 # using DOT_FONTNAME. You need need to make sure dot is able to find the font,
    1360 # which can be done by putting it in a standard location or by setting the
    1361 # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory
    1362 # containing the font.
     1695HAVE_DOT               = NO
     1696
     1697# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
     1698# allowed to run in parallel. When set to 0 (the default) doxygen will
     1699# base this on the number of processors available in the system. You can set it
     1700# explicitly to a value larger than 0 to get control over the balance
     1701# between CPU load and processing speed.
     1702
     1703DOT_NUM_THREADS        = 0
     1704
     1705# By default doxygen will use the Helvetica font for all dot files that
     1706# doxygen generates. When you want a differently looking font you can specify
     1707# the font name using DOT_FONTNAME. You need to make sure dot is able to find
     1708# the font, which can be done by putting it in a standard location or by setting
     1709# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
     1710# directory containing the font.
    13631711
    13641712DOT_FONTNAME           = FreeSans
     
    13691717DOT_FONTSIZE           = 10
    13701718
    1371 # By default doxygen will tell dot to use the output directory to look for the
    1372 # FreeSans.ttf font (which doxygen will put there itself). If you specify a
    1373 # different font using DOT_FONTNAME you can set the path where dot
    1374 # can find it using this tag.
     1719# By default doxygen will tell dot to use the Helvetica font.
     1720# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
     1721# set the path where dot can find it.
    13751722
    13761723DOT_FONTPATH           =
     
    13791726# will generate a graph for each documented class showing the direct and
    13801727# indirect inheritance relations. Setting this tag to YES will force the
    1381 # the CLASS_DIAGRAMS tag to NO.
     1728# CLASS_DIAGRAMS tag to NO.
    13821729
    13831730CLASS_GRAPH            = YES
     
    14001747
    14011748UML_LOOK               = NO
     1749
     1750# If the UML_LOOK tag is enabled, the fields and methods are shown inside
     1751# the class node. If there are many fields or methods and many nodes the
     1752# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
     1753# threshold limits the number of items for each type to make the size more
     1754# managable. Set this to 0 for no limit. Note that the threshold may be
     1755# exceeded by 50% before the limit is enforced.
     1756
     1757UML_LIMIT_NUM_FIELDS   = 10
    14021758
    14031759# If set to YES, the inheritance and collaboration graphs will show the
     
    14371793
    14381794# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
    1439 # will graphical hierarchy of all classes instead of a textual one.
     1795# will generate a graphical hierarchy of all classes instead of a textual one.
    14401796
    14411797GRAPHICAL_HIERARCHY    = YES
    14421798
    1443 # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
     1799# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
    14441800# then doxygen will show the dependencies a directory has on other directories
    14451801# in a graphical way. The dependency relations are determined by the #include
     
    14491805
    14501806# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
    1451 # generated by dot. Possible values are png, jpg, or gif
    1452 # If left blank png will be used.
     1807# generated by dot. Possible values are svg, png, jpg, or gif.
     1808# If left blank png will be used. If you choose svg you need to set
     1809# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
     1810# visible in IE 9+ (other browsers do not have this requirement).
    14531811
    14541812DOT_IMAGE_FORMAT       = png
     1813
     1814# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
     1815# enable generation of interactive SVG images that allow zooming and panning.
     1816# Note that this requires a modern browser other than Internet Explorer.
     1817# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
     1818# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
     1819# visible. Older versions of IE do not have SVG support.
     1820
     1821INTERACTIVE_SVG        = NO
    14551822
    14561823# The tag DOT_PATH can be used to specify the path where the dot tool can be
     
    14641831
    14651832DOTFILE_DIRS           =
     1833
     1834# The MSCFILE_DIRS tag can be used to specify one or more directories that
     1835# contain msc files that are included in the documentation (see the
     1836# \mscfile command).
     1837
     1838MSCFILE_DIRS           =
    14661839
    14671840# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
  • python/lib/gen_pyobject.py

    rac20c85 rbb42f65  
    478478""" % {'funcname': method_name, 'objname': name,
    479479        'out_type': out_type, 'setter_args': setter_args, 'parse_args': parse_args }
    480         shortname = method_name.split(name+'_')[-1]
     480        shortname = method_name.split('aubio_'+name+'_')[-1]
    481481        method_defs += """\
    482482  {"%(shortname)s", (PyCFunction) Py%(method_name)s,
     
    494494        getter_args = "self->o"
    495495        returnval = "(PyObject *)" + aubiovectopyobj[out_type] + " (tmp)"
    496         shortname = method_name.split(name+'_')[-1]
     496        shortname = method_name.split('aubio_'+name+'_')[-1]
    497497        method_defs += """\
    498498  {"%(shortname)s", (PyCFunction) Py%(method_name)s,
  • src/pitch/pitchyinfft.c

    rac20c85 rbb42f65  
    11/*
    2   Copyright (C) 2003-2009 Paul Brossier <piem@aubio.org>
     2  Copyright (C) 2003-2013 Paul Brossier <piem@aubio.org>
    33
    44  This file is part of aubio.
     
    3131  fvec_t *win;        /**< temporal weighting window */
    3232  fvec_t *winput;     /**< windowed spectrum */
    33   cvec_t *res;        /**< complex vector to compute square difference function */
    3433  fvec_t *sqrmag;     /**< square difference function */
    3534  fvec_t *weight;     /**< spectral weighting window (psychoacoustic model) */
    36   cvec_t *fftout;     /**< Fourier transform output */
     35  fvec_t *fftout;     /**< Fourier transform output */
    3736  aubio_fft_t *fft;   /**< fft object to compute square difference function */
    3837  fvec_t *yinfft;     /**< Yin function */
     
    5958  p->winput = new_fvec (bufsize);
    6059  p->fft = new_aubio_fft (bufsize);
    61   p->fftout = new_cvec (bufsize);
     60  p->fftout = new_fvec (bufsize);
    6261  p->sqrmag = new_fvec (bufsize);
    63   p->res = new_cvec (bufsize);
    6462  p->yinfft = new_fvec (bufsize / 2 + 1);
    6563  p->tol = 0.85;
     
    9997{
    10098  uint_t tau, l;
     99  uint_t length = p->fftout->length;
    101100  uint_t halfperiod;
    102   smpl_t tmp, sum;
    103   cvec_t *res = (cvec_t *) p->res;
    104   fvec_t *yin = (fvec_t *) p->yinfft;
    105   l = 0;
    106   tmp = 0.;
    107   sum = 0.;
     101  fvec_t *fftout = p->fftout;
     102  fvec_t *yin = p->yinfft;
     103  smpl_t tmp = 0., sum = 0.;
     104  // window the input
    108105  for (l = 0; l < input->length; l++) {
    109106    p->winput->data[l] = p->win->data[l] * input->data[l];
    110107  }
    111   aubio_fft_do (p->fft, p->winput, p->fftout);
    112   for (l = 0; l < p->fftout->length; l++) {
    113     p->sqrmag->data[l] = SQR (p->fftout->norm[l]);
     108  // get the real / imag parts of its fft
     109  aubio_fft_do_complex (p->fft, p->winput, fftout);
     110  // get the squared magnitude spectrum, applying some weight
     111  p->sqrmag->data[0] = SQR(fftout->data[0]);
     112  p->sqrmag->data[0] *= p->weight->data[0];
     113  for (l = 1; l < length / 2; l++) {
     114    p->sqrmag->data[l] = SQR(fftout->data[l]) + SQR(fftout->data[length - l]);
    114115    p->sqrmag->data[l] *= p->weight->data[l];
     116    p->sqrmag->data[length - l] = p->sqrmag->data[l];
    115117  }
    116   for (l = 1; l < p->fftout->length; l++) {
    117     p->sqrmag->data[(p->fftout->length - 1) * 2 - l] =
    118         SQR (p->fftout->norm[l]);
    119     p->sqrmag->data[(p->fftout->length - 1) * 2 - l] *=
    120         p->weight->data[l];
    121   }
    122   for (l = 0; l < p->sqrmag->length / 2 + 1; l++) {
     118  p->sqrmag->data[length / 2] = SQR(fftout->data[length / 2]);
     119  p->sqrmag->data[length / 2] *= p->weight->data[length / 2];
     120  // get sum of weighted squared mags
     121  for (l = 0; l < length / 2 + 1; l++) {
    123122    sum += p->sqrmag->data[l];
    124123  }
    125124  sum *= 2.;
    126   aubio_fft_do (p->fft, p->sqrmag, res);
     125  // get the real / imag parts of the fft of the squared magnitude
     126  aubio_fft_do_complex (p->fft, p->sqrmag, fftout);
    127127  yin->data[0] = 1.;
    128128  for (tau = 1; tau < yin->length; tau++) {
    129     yin->data[tau] = sum - res->norm[tau] * COS (res->phas[tau]);
     129    // compute the square differences
     130    yin->data[tau] = sum - fftout->data[tau];
     131    // and the cumulative mean normalized difference function
    130132    tmp += yin->data[tau];
    131133    yin->data[tau] *= tau / tmp;
    132134  }
     135  // find best candidates
    133136  tau = fvec_min_elem (yin);
    134137  if (yin->data[tau] < p->tol) {
    135     /* no interpolation */
    136     //return tau;
    137     /* 3 point quadratic interpolation */
     138    // no interpolation, directly return the period as an integer
     139    //output->data[0] = tau;
     140    //return;
     141
     142    // 3 point quadratic interpolation
    138143    //return fvec_quadint_min(yin,tau,1);
    139144    /* additional check for (unlikely) octave doubling in higher frequencies */
     
    160165  del_fvec (p->yinfft);
    161166  del_fvec (p->sqrmag);
    162   del_cvec (p->res);
    163   del_cvec (p->fftout);
     167  del_fvec (p->fftout);
    164168  del_fvec (p->winput);
    165169  del_fvec (p->weight);
Note: See TracChangeset for help on using the changeset viewer.