cannam@154: # Doxyfile 1.8.10
cannam@154: 
cannam@154: # This file describes the settings to be used by the documentation system
cannam@154: # doxygen (www.doxygen.org) for a project.
cannam@154: #
cannam@154: # All text after a double hash (##) is considered a comment and is placed in
cannam@154: # front of the TAG it is preceding.
cannam@154: #
cannam@154: # All text after a single hash (#) is considered a comment and will be ignored.
cannam@154: # The format is:
cannam@154: # TAG = value [value, ...]
cannam@154: # For lists, items can also be appended using:
cannam@154: # TAG += value [value, ...]
cannam@154: # Values that contain spaces should be placed between quotes (\" \").
cannam@154: 
cannam@154: # Only non-default options are included below to improve portability
cannam@154: # between doxygen versions.
cannam@154: #
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Project related configuration options
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
cannam@154: # double-quotes, unless you are using Doxywizard) that should identify the
cannam@154: # project for which the documentation is generated. This name is used in the
cannam@154: # title of most generated pages and in a few other places.
cannam@154: # The default value is: My Project.
cannam@154: 
cannam@154: PROJECT_NAME           = Opus
cannam@154: 
cannam@154: # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
cannam@154: # could be handy for archiving the generated documentation or if some version
cannam@154: # control system is used.
cannam@154: 
cannam@154: PROJECT_NUMBER         = @VERSION@
cannam@154: 
cannam@154: # Using the PROJECT_BRIEF tag one can provide an optional one line description
cannam@154: # for a project that appears at the top of each page and should give viewer a
cannam@154: # quick idea about the purpose of the project. Keep the description short.
cannam@154: 
cannam@154: PROJECT_BRIEF          = "Opus audio codec (RFC 6716): API and operations manual"
cannam@154: 
cannam@154: # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
cannam@154: # in the documentation. The maximum height of the logo should not exceed 55
cannam@154: # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
cannam@154: # the logo to the output directory.
cannam@154: 
cannam@154: PROJECT_LOGO           =
cannam@154: 
cannam@154: # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
cannam@154: # before files name in the file list and in the header files. If set to NO the
cannam@154: # shortest path that makes the file name unique will be used
cannam@154: # The default value is: YES.
cannam@154: 
cannam@154: FULL_PATH_NAMES        = NO
cannam@154: 
cannam@154: # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
cannam@154: # first line (until the first dot) of a Javadoc-style comment as the brief
cannam@154: # description. If set to NO, the Javadoc-style will behave just like regular Qt-
cannam@154: # style comments (thus requiring an explicit @brief command for a brief
cannam@154: # description.)
cannam@154: # The default value is: NO.
cannam@154: 
cannam@154: JAVADOC_AUTOBRIEF      = YES
cannam@154: 
cannam@154: # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
cannam@154: # uses this value to replace tabs by spaces in code fragments.
cannam@154: # Minimum value: 1, maximum value: 16, default value: 4.
cannam@154: 
cannam@154: TAB_SIZE               = 8
cannam@154: 
cannam@154: # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
cannam@154: # only. Doxygen will then generate output that is more tailored for C. For
cannam@154: # instance, some of the names that are used will be different. The list of all
cannam@154: # members will be omitted, etc.
cannam@154: # The default value is: NO.
cannam@154: 
cannam@154: OPTIMIZE_OUTPUT_FOR_C  = YES
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Build related configuration options
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
cannam@154: # documentation are documented, even if no documentation was available. Private
cannam@154: # class members and static file members will be hidden unless the
cannam@154: # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
cannam@154: # Note: This will also disable the warnings about undocumented members that are
cannam@154: # normally produced when WARNINGS is set to YES.
cannam@154: # The default value is: NO.
cannam@154: 
cannam@154: EXTRACT_ALL            = YES
cannam@154: 
cannam@154: # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
cannam@154: # be included in the documentation.
cannam@154: # The default value is: NO.
cannam@154: 
cannam@154: EXTRACT_PRIVATE        = NO
cannam@154: 
cannam@154: # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
cannam@154: # names in lower-case letters. If set to YES, upper-case letters are also
cannam@154: # allowed. This is useful if you have classes or files whose names only differ
cannam@154: # in case and if your file system supports case sensitive file names. Windows
cannam@154: # and Mac users are advised to set this option to NO.
cannam@154: # The default value is: system dependent.
cannam@154: 
cannam@154: CASE_SENSE_NAMES       = YES
cannam@154: 
cannam@154: # The ENABLED_SECTIONS tag can be used to enable conditional documentation
cannam@154: # sections, marked by \if <section_label> ... \endif and \cond <section_label>
cannam@154: # ... \endcond blocks.
cannam@154: 
cannam@154: ENABLED_SECTIONS       =
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to warning and progress messages
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # The QUIET tag can be used to turn on/off the messages that are generated to
cannam@154: # standard output by doxygen. If QUIET is set to YES this implies that the
cannam@154: # messages are off.
cannam@154: # The default value is: NO.
cannam@154: 
cannam@154: QUIET                  = YES
cannam@154: 
cannam@154: # The WARNINGS tag can be used to turn on/off the warning messages that are
cannam@154: # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
cannam@154: # this implies that the warnings are on.
cannam@154: #
cannam@154: # Tip: Turn warnings on while writing the documentation.
cannam@154: # The default value is: YES.
cannam@154: 
cannam@154: WARNINGS               = YES
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the input files
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # The INPUT tag is used to specify the files and/or directories that contain
cannam@154: # documented source files. You may enter file names like myfile.cpp or
cannam@154: # directories like /usr/src/myproject. Separate the files or directories with
cannam@154: # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
cannam@154: # Note: If this tag is empty the current directory is searched.
cannam@154: 
cannam@154: INPUT                  = @top_srcdir@/include/opus.h \
cannam@154:                          @top_srcdir@/include/opus_types.h \
cannam@154:                          @top_srcdir@/include/opus_defines.h \
cannam@154:                          @top_srcdir@/include/opus_multistream.h \
cannam@154:                          @top_srcdir@/include/opus_custom.h
cannam@154: 
cannam@154: # The EXCLUDE tag can be used to specify files and/or directories that should be
cannam@154: # excluded from the INPUT source files. This way you can easily exclude a
cannam@154: # subdirectory from a directory tree whose root is specified with the INPUT tag.
cannam@154: #
cannam@154: # Note that relative paths are relative to the directory from which doxygen is
cannam@154: # run.
cannam@154: 
cannam@154: EXCLUDE                =
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the alphabetical class index
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
cannam@154: # compounds will be generated. Enable this if the project contains a lot of
cannam@154: # classes, structs, unions or interfaces.
cannam@154: # The default value is: YES.
cannam@154: 
cannam@154: ALPHABETICAL_INDEX     = NO
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the HTML output
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # The HTML_HEADER tag can be used to specify a user-defined HTML header file for
cannam@154: # each generated HTML page. If the tag is left blank doxygen will generate a
cannam@154: # standard header.
cannam@154: #
cannam@154: # To get valid HTML the header file that includes any scripts and style sheets
cannam@154: # that doxygen needs, which is dependent on the configuration options used (e.g.
cannam@154: # the setting GENERATE_TREEVIEW). It is highly recommended to start with a
cannam@154: # default header using
cannam@154: # doxygen -w html new_header.html new_footer.html new_stylesheet.css
cannam@154: # YourConfigFile
cannam@154: # and then modify the file new_header.html. See also section "Doxygen usage"
cannam@154: # for information on how to generate the default header that doxygen normally
cannam@154: # uses.
cannam@154: # Note: The header is subject to change so you typically have to regenerate the
cannam@154: # default header when upgrading to a newer version of doxygen. For a description
cannam@154: # of the possible markers and block names see the documentation.
cannam@154: # This tag requires that the tag GENERATE_HTML is set to YES.
cannam@154: 
cannam@154: HTML_HEADER            = @top_srcdir@/doc/header.html
cannam@154: 
cannam@154: # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
cannam@154: # generated HTML page. If the tag is left blank doxygen will generate a standard
cannam@154: # footer. See HTML_HEADER for more information on how to generate a default
cannam@154: # footer and what special commands can be used inside the footer. See also
cannam@154: # section "Doxygen usage" for information on how to generate the default footer
cannam@154: # that doxygen normally uses.
cannam@154: # This tag requires that the tag GENERATE_HTML is set to YES.
cannam@154: 
cannam@154: HTML_FOOTER            = @top_srcdir@/doc/footer.html
cannam@154: 
cannam@154: # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
cannam@154: # sheet that is used by each HTML page. It can be used to fine-tune the look of
cannam@154: # the HTML output. If left blank doxygen will generate a default style sheet.
cannam@154: # See also section "Doxygen usage" for information on how to generate the style
cannam@154: # sheet that doxygen normally uses.
cannam@154: # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
cannam@154: # it is more robust and this tag (HTML_STYLESHEET) will in the future become
cannam@154: # obsolete.
cannam@154: # This tag requires that the tag GENERATE_HTML is set to YES.
cannam@154: 
cannam@154: HTML_STYLESHEET        = @top_srcdir@/doc/customdoxygen.css
cannam@154: 
cannam@154: # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
cannam@154: # other source files which should be copied to the HTML output directory. Note
cannam@154: # that these files will be copied to the base HTML output directory. Use the
cannam@154: # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
cannam@154: # files. In the HTML_STYLESHEET file, use the file name only. Also note that the
cannam@154: # files will be copied as-is; there are no commands or markers available.
cannam@154: # This tag requires that the tag GENERATE_HTML is set to YES.
cannam@154: 
cannam@154: HTML_EXTRA_FILES       = @top_srcdir@/doc/opus_logo.svg
cannam@154: 
cannam@154: # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
cannam@154: # in the HTML output. For a value of 0 the output will use grayscales only. A
cannam@154: # value of 255 will produce the most vivid colors.
cannam@154: # Minimum value: 0, maximum value: 255, default value: 100.
cannam@154: # This tag requires that the tag GENERATE_HTML is set to YES.
cannam@154: 
cannam@154: HTML_COLORSTYLE_SAT    = 0
cannam@154: 
cannam@154: # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
cannam@154: # page will contain the date and time when the page was generated. Setting this
cannam@154: # to YES can help to show when doxygen was last run and thus if the
cannam@154: # documentation is up to date.
cannam@154: # The default value is: NO.
cannam@154: # This tag requires that the tag GENERATE_HTML is set to YES.
cannam@154: 
cannam@154: HTML_TIMESTAMP         = YES
cannam@154: 
cannam@154: # When MathJax is enabled you need to specify the location relative to the HTML
cannam@154: # output directory using the MATHJAX_RELPATH option. The destination directory
cannam@154: # should contain the MathJax.js script. For instance, if the mathjax directory
cannam@154: # is located at the same level as the HTML output directory, then
cannam@154: # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
cannam@154: # Content Delivery Network so you can quickly see the result without installing
cannam@154: # MathJax. However, it is strongly recommended to install a local copy of
cannam@154: # MathJax from http://www.mathjax.org before deployment.
cannam@154: # The default value is: http://cdn.mathjax.org/mathjax/latest.
cannam@154: # This tag requires that the tag USE_MATHJAX is set to YES.
cannam@154: 
cannam@154: MATHJAX_RELPATH        = https://www.mathjax.org/mathjax
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the LaTeX output
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # The PAPER_TYPE tag can be used to set the paper type that is used by the
cannam@154: # printer.
cannam@154: # Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
cannam@154: # 14 inches) and executive (7.25 x 10.5 inches).
cannam@154: # The default value is: a4.
cannam@154: # This tag requires that the tag GENERATE_LATEX is set to YES.
cannam@154: 
cannam@154: PAPER_TYPE             = letter
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the man page output
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
cannam@154: # classes and files.
cannam@154: # The default value is: NO.
cannam@154: 
cannam@154: GENERATE_MAN           = YES
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the preprocessor
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
cannam@154: # in the source code. If set to NO, only conditional compilation will be
cannam@154: # performed. Macro expansion can be done in a controlled way by setting
cannam@154: # EXPAND_ONLY_PREDEF to YES.
cannam@154: # The default value is: NO.
cannam@154: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
cannam@154: 
cannam@154: MACRO_EXPANSION        = YES
cannam@154: 
cannam@154: # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
cannam@154: # the macro expansion is limited to the macros specified with the PREDEFINED and
cannam@154: # EXPAND_AS_DEFINED tags.
cannam@154: # The default value is: NO.
cannam@154: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
cannam@154: 
cannam@154: EXPAND_ONLY_PREDEF     = YES
cannam@154: 
cannam@154: # The INCLUDE_PATH tag can be used to specify one or more directories that
cannam@154: # contain include files that are not input files but should be processed by the
cannam@154: # preprocessor.
cannam@154: # This tag requires that the tag SEARCH_INCLUDES is set to YES.
cannam@154: 
cannam@154: INCLUDE_PATH           =
cannam@154: 
cannam@154: # The PREDEFINED tag can be used to specify one or more macro names that are
cannam@154: # defined before the preprocessor is started (similar to the -D option of e.g.
cannam@154: # gcc). The argument of the tag is a list of macros of the form: name or
cannam@154: # name=definition (no spaces). If the definition and the "=" are omitted, "=1"
cannam@154: # is assumed. To prevent a macro definition from being undefined via #undef or
cannam@154: # recursively expanded use the := operator instead of the = operator.
cannam@154: # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
cannam@154: 
cannam@154: PREDEFINED             = OPUS_EXPORT= \
cannam@154:                          OPUS_CUSTOM_EXPORT= \
cannam@154:                          OPUS_CUSTOM_EXPORT_STATIC= \
cannam@154:                          OPUS_WARN_UNUSED_RESULT= \
cannam@154:                          OPUS_ARG_NONNULL(_x)=
cannam@154: 
cannam@154: #---------------------------------------------------------------------------
cannam@154: # Configuration options related to the dot tool
cannam@154: #---------------------------------------------------------------------------
cannam@154: 
cannam@154: # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
cannam@154: # available from the path. This tool is part of Graphviz (see:
cannam@154: # http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
cannam@154: # Bell Labs.
cannam@154: 
cannam@154: # Debian defaults to YES here, while Fedora and Homebrew default to NO.
cannam@154: # So we set this based on whether the graphviz package is available at
cannam@154: # configure time.
cannam@154: #
cannam@154: HAVE_DOT = @HAVE_DOT@