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