Changeset 155cc10 for doc/full.cfg


Ignore:
Timestamp:
Mar 10, 2017, 2:26:32 PM (3 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, sampler
Children:
ee8a57c
Parents:
00d0275 (diff), 67b6618 (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 'master' into awhitening

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/full.cfg

    r00d0275 r155cc10  
    1 # Doxyfile 1.8.5
     1# Doxyfile 1.8.8
    22
    33# This file describes the settings to be used by the documentation system
     
    3939# control system is used.
    4040
    41 PROJECT_NUMBER         = "0.4.2~alpha full"
     41PROJECT_NUMBER         = "0.4.5~alpha"
    4242
    4343# Using the PROJECT_BRIEF tag one can provide an optional one line description
     
    7171CREATE_SUBDIRS         = NO
    7272
     73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
     74# characters to appear in the names of generated files. If set to NO, non-ASCII
     75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
     76# U+3044.
     77# The default value is: NO.
     78
     79ALLOW_UNICODE_NAMES    = NO
     80
    7381# The OUTPUT_LANGUAGE tag is used to specify the language in which all
    7482# documentation generated by doxygen is written. Doxygen will use this
    7583# information to generate all constant output in the proper language.
    76 # Possible values are: Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-
    77 # Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi,
    78 # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en,
    79 # Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish,
    80 # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish,
    81 # Turkish, Ukrainian and Vietnamese.
     84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
     85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
     86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
     87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
     88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
     89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
     90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
     91# Ukrainian and Vietnamese.
    8292# The default value is: English.
    8393
     
    260270# using this tag. The format is ext=language, where ext is a file extension, and
    261271# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
    262 # C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make
    263 # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
    264 # (default is Fortran), use: inc=Fortran f=C.
     272# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
     273# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
     274# Fortran. In the later case the parser tries to guess whether the code is fixed
     275# or free formatted code, this is the default for Fortran type files), VHDL. For
     276# instance to make doxygen treat .inc files as Fortran files (default is PHP),
     277# and .f files as C (default is Fortran), use: inc=Fortran f=C.
    265278#
    266279# Note For files without extension you can use no_extension as a placeholder.
     
    501514SHOW_INCLUDE_FILES     = YES
    502515
     516# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
     517# grouped member an include statement to the documentation, telling the reader
     518# which file to include in order to use the member.
     519# The default value is: NO.
     520
     521SHOW_GROUPED_MEMB_INC  = NO
     522
    503523# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
    504524# files with double quotes in the documentation rather than with sharp brackets.
     
    522542# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
    523543# descriptions of file, namespace and class members alphabetically by member
    524 # name. If set to NO the members will appear in declaration order.
     544# name. If set to NO the members will appear in declaration order. Note that
     545# this will also influence the order of the classes in the class list.
    525546# The default value is: NO.
    526547
     
    660681# For LaTeX the style of the bibliography can be controlled using
    661682# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
    662 # search path. Do not use file names with spaces, bibtex cannot handle them. See
    663 # also \cite for info how to create references.
     683# search path. See also \cite for info how to create references.
    664684
    665685CITE_BIB_FILES         =
     
    959979
    960980VERBATIM_HEADERS       = YES
     981
     982# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the
     983# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
     984# cost of reduced performance. This can be particularly helpful with template
     985# rich C++ code for which doxygen's built-in parser lacks the necessary type
     986# information.
     987# Note: The availability of this option depends on whether or not doxygen was
     988# compiled with the --with-libclang option.
     989# The default value is: NO.
     990
     991CLANG_ASSISTED_PARSING = NO
     992
     993# If clang assisted parsing is enabled you can provide the compiler with command
     994# line options that you would normally use when invoking the compiler. Note that
     995# the include paths will already be set by doxygen for the files and directories
     996# specified with INPUT and INCLUDE_PATH.
     997# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
     998
     999CLANG_OPTIONS          =
    9611000
    9621001#---------------------------------------------------------------------------
     
    10521091HTML_STYLESHEET        =
    10531092
    1054 # The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user-
    1055 # defined cascading style sheet that is included after the standard style sheets
     1093# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
     1094# cascading style sheets that are included after the standard style sheets
    10561095# created by doxygen. Using this option one can overrule certain style aspects.
    10571096# This is preferred over using HTML_STYLESHEET since it does not replace the
    10581097# standard style sheet and is therefor more robust against future updates.
    1059 # Doxygen will copy the style sheet file to the output directory. For an example
    1060 # see the documentation.
     1098# Doxygen will copy the style sheet files to the output directory.
     1099# Note: The order of the extra stylesheet files is of importance (e.g. the last
     1100# stylesheet in the list overrules the setting of the previous ones in the
     1101# list). For an example see the documentation.
    10611102# This tag requires that the tag GENERATE_HTML is set to YES.
    10621103
     
    12231264
    12241265# The BINARY_TOC flag controls whether a binary table of contents is generated (
    1225 # YES) or a normal table of contents ( NO) in the .chm file.
     1266# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it
     1267# enables the Previous and Next buttons.
    12261268# The default value is: NO.
    12271269# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
     
    14231465# This tag requires that the tag USE_MATHJAX is set to YES.
    14241466
    1425 MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
     1467MATHJAX_RELPATH        = https://cdn.mathjax.org/mathjax/latest
    14261468
    14271469# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
     
    14631505# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
    14641506# implemented using a web server instead of a web client using Javascript. There
    1465 # are two flavours of web server based searching depending on the
    1466 # EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for
    1467 # searching and an index file used by the script. When EXTERNAL_SEARCH is
    1468 # enabled the indexing and searching needs to be provided by external tools. See
    1469 # the section "External Indexing and Searching" for details.
     1507# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
     1508# setting. When disabled, doxygen will generate a PHP script for searching and
     1509# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
     1510# and searching needs to be provided by external tools. See the section
     1511# "External Indexing and Searching" for details.
    14701512# The default value is: NO.
    14711513# This tag requires that the tag SEARCHENGINE is set to YES.
     
    15951637# Note: Only use a user-defined header if you know what you are doing! The
    15961638# following commands have a special meaning inside the header: $title,
    1597 # $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will
    1598 # replace them by respectively the title of the page, the current date and time,
    1599 # only the current date, the version number of doxygen, the project name (see
    1600 # PROJECT_NAME), or the project number (see PROJECT_NUMBER).
     1639# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
     1640# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string,
     1641# for the replacement values of the other commands the user is refered to
     1642# HTML_HEADER.
    16011643# This tag requires that the tag GENERATE_LATEX is set to YES.
    16021644
     
    16051647# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
    16061648# generated LaTeX document. The footer should contain everything after the last
    1607 # chapter. If it is left blank doxygen will generate a standard footer.
     1649# chapter. If it is left blank doxygen will generate a standard footer. See
     1650# LATEX_HEADER for more information on how to generate a default footer and what
     1651# special commands can be used inside the footer.
    16081652#
    16091653# Note: Only use a user-defined footer if you know what you are doing!
     
    16291673PDF_HYPERLINKS         = YES
    16301674
    1631 # If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
     1675# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
    16321676# the PDF file directly from the LaTeX files. Set this option to YES to get a
    16331677# higher quality PDF documentation.
     
    17551799MAN_EXTENSION          = .3
    17561800
     1801# The MAN_SUBDIR tag determines the name of the directory created within
     1802# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
     1803# MAN_EXTENSION with the initial . removed.
     1804# This tag requires that the tag GENERATE_MAN is set to YES.
     1805
     1806MAN_SUBDIR             =
     1807
    17571808# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
    17581809# will generate one additional man file for each entity documented in the real
     
    17821833XML_OUTPUT             = xml
    17831834
    1784 # The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
    1785 # validating XML parser to check the syntax of the XML files.
    1786 # This tag requires that the tag GENERATE_XML is set to YES.
    1787 
    1788 XML_SCHEMA             =
    1789 
    1790 # The XML_DTD tag can be used to specify a XML DTD, which can be used by a
    1791 # validating XML parser to check the syntax of the XML files.
    1792 # This tag requires that the tag GENERATE_XML is set to YES.
    1793 
    1794 XML_DTD                =
    1795 
    17961835# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
    17971836# listings (including syntax highlighting and cross-referencing information) to
     
    18201859
    18211860DOCBOOK_OUTPUT         = docbook
     1861
     1862# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the
     1863# program listings (including syntax highlighting and cross-referencing
     1864# information) to the DOCBOOK output. Note that enabling this will significantly
     1865# increase the size of the DOCBOOK output.
     1866# The default value is: NO.
     1867# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
     1868
     1869DOCBOOK_PROGRAMLISTING = NO
    18221870
    18231871#---------------------------------------------------------------------------
     
    19401988
    19411989# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
    1942 # remove all refrences to function-like macros that are alone on a line, have an
    1943 # all uppercase name, and do not end with a semicolon. Such function macros are
    1944 # typically used for boiler-plate code, and will confuse the parser if not
     1990# remove all references to function-like macros that are alone on a line, have
     1991# an all uppercase name, and do not end with a semicolon. Such function macros
     1992# are typically used for boiler-plate code, and will confuse the parser if not
    19451993# removed.
    19461994# The default value is: YES.
     
    19622010# section "Linking to external documentation" for more information about the use
    19632011# of tag files.
    1964 # Note: Each tag file must have an unique name (where the name does NOT include
     2012# Note: Each tag file must have a unique name (where the name does NOT include
    19652013# the path). If a tag file is not located in the directory in which doxygen is
    19662014# run, you must also specify the path to the tagfile here.
     
    20222070MSCGEN_PATH            =
    20232071
     2072# You can include diagrams made with dia in doxygen documentation. Doxygen will
     2073# then run dia to produce the diagram and insert it in the documentation. The
     2074# DIA_PATH tag allows you to specify the directory where the dia binary resides.
     2075# If left empty dia is assumed to be found in the default search path.
     2076
     2077DIA_PATH               =
     2078
    20242079# If set to YES, the inheritance and collaboration graphs will hide inheritance
    20252080# and usage relations if the target is undocumented or is not a class.
     
    20332088# Bell Labs. The other options in this section have no effect if this option is
    20342089# set to NO
    2035 # The default value is: NO.
     2090# The default value is: YES.
    20362091
    20372092HAVE_DOT               = NO
     
    20472102DOT_NUM_THREADS        = 0
    20482103
    2049 # When you want a differently looking font n the dot files that doxygen
     2104# When you want a differently looking font in the dot files that doxygen
    20502105# generates you can specify the font name using DOT_FONTNAME. You need to make
    20512106# sure dot is able to find the font, which can be done by putting it in a
     
    21852240# to make the SVG files visible in IE 9+ (other browsers do not have this
    21862241# requirement).
    2187 # Possible values are: png, jpg, gif and svg.
     2242# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
     2243# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
     2244# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
    21882245# The default value is: png.
    21892246# This tag requires that the tag HAVE_DOT is set to YES.
     
    22212278
    22222279MSCFILE_DIRS           =
     2280
     2281# The DIAFILE_DIRS tag can be used to specify one or more directories that
     2282# contain dia files that are included in the documentation (see the \diafile
     2283# command).
     2284
     2285DIAFILE_DIRS           =
     2286
     2287# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
     2288# path where java can find the plantuml.jar file. If left blank, it is assumed
     2289# PlantUML is not used or called during a preprocessing step. Doxygen will
     2290# generate a warning when it encounters a \startuml command in this case and
     2291# will not generate output for the diagram.
     2292# This tag requires that the tag HAVE_DOT is set to YES.
     2293
     2294PLANTUML_JAR_PATH      =
    22232295
    22242296# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
Note: See TracChangeset for help on using the changeset viewer.