1# Doxyfile 1.8.10 2 3# This file describes the settings to be used by the documentation system 4# doxygen (www.doxygen.org) for a project. 5# 6# All text after a double hash (##) is considered a comment and is placed in 7# front of the TAG it is preceding. 8# 9# All text after a single hash (#) is considered a comment and will be ignored. 10# The format is: 11# TAG = value [value, ...] 12# For lists, items can also be appended using: 13# TAG += value [value, ...] 14# Values that contain spaces should be placed between quotes (\" \"). 15 16# Only non-default options are included below to improve portability 17# between doxygen versions. 18# 19#--------------------------------------------------------------------------- 20# Project related configuration options 21#--------------------------------------------------------------------------- 22 23# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 24# double-quotes, unless you are using Doxywizard) that should identify the 25# project for which the documentation is generated. This name is used in the 26# title of most generated pages and in a few other places. 27# The default value is: My Project. 28 29PROJECT_NAME = Opus 30 31# The PROJECT_NUMBER tag can be used to enter a project or revision number. This 32# could be handy for archiving the generated documentation or if some version 33# control system is used. 34 35PROJECT_NUMBER = @VERSION@ 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 a 39# quick idea about the purpose of the project. Keep the description short. 40 41PROJECT_BRIEF = "Opus audio codec (RFC 6716): API and operations manual" 42 43# With the PROJECT_LOGO tag one can specify a logo or an icon that is included 44# in the documentation. The maximum height of the logo should not exceed 55 45# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 46# the logo to the output directory. 47 48PROJECT_LOGO = 49 50# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 51# before files name in the file list and in the header files. If set to NO the 52# shortest path that makes the file name unique will be used 53# The default value is: YES. 54 55FULL_PATH_NAMES = NO 56 57# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 58# first line (until the first dot) of a Javadoc-style comment as the brief 59# description. If set to NO, the Javadoc-style will behave just like regular Qt- 60# style comments (thus requiring an explicit @brief command for a brief 61# description.) 62# The default value is: NO. 63 64JAVADOC_AUTOBRIEF = YES 65 66# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 67# uses this value to replace tabs by spaces in code fragments. 68# Minimum value: 1, maximum value: 16, default value: 4. 69 70TAB_SIZE = 8 71 72# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 73# only. Doxygen will then generate output that is more tailored for C. For 74# instance, some of the names that are used will be different. The list of all 75# members will be omitted, etc. 76# The default value is: NO. 77 78OPTIMIZE_OUTPUT_FOR_C = YES 79 80#--------------------------------------------------------------------------- 81# Build related configuration options 82#--------------------------------------------------------------------------- 83 84# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 85# documentation are documented, even if no documentation was available. Private 86# class members and static file members will be hidden unless the 87# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 88# Note: This will also disable the warnings about undocumented members that are 89# normally produced when WARNINGS is set to YES. 90# The default value is: NO. 91 92EXTRACT_ALL = YES 93 94# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 95# be included in the documentation. 96# The default value is: NO. 97 98EXTRACT_PRIVATE = NO 99 100# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 101# names in lower-case letters. If set to YES, upper-case letters are also 102# allowed. This is useful if you have classes or files whose names only differ 103# in case and if your file system supports case sensitive file names. Windows 104# and Mac users are advised to set this option to NO. 105# The default value is: system dependent. 106 107CASE_SENSE_NAMES = YES 108 109# The ENABLED_SECTIONS tag can be used to enable conditional documentation 110# sections, marked by \if <section_label> ... \endif and \cond <section_label> 111# ... \endcond blocks. 112 113ENABLED_SECTIONS = 114 115#--------------------------------------------------------------------------- 116# Configuration options related to warning and progress messages 117#--------------------------------------------------------------------------- 118 119# The QUIET tag can be used to turn on/off the messages that are generated to 120# standard output by doxygen. If QUIET is set to YES this implies that the 121# messages are off. 122# The default value is: NO. 123 124QUIET = YES 125 126# The WARNINGS tag can be used to turn on/off the warning messages that are 127# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 128# this implies that the warnings are on. 129# 130# Tip: Turn warnings on while writing the documentation. 131# The default value is: YES. 132 133WARNINGS = YES 134 135#--------------------------------------------------------------------------- 136# Configuration options related to the input files 137#--------------------------------------------------------------------------- 138 139# The INPUT tag is used to specify the files and/or directories that contain 140# documented source files. You may enter file names like myfile.cpp or 141# directories like /usr/src/myproject. Separate the files or directories with 142# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 143# Note: If this tag is empty the current directory is searched. 144 145INPUT = @top_srcdir@/include/opus.h \ 146 @top_srcdir@/include/opus_types.h \ 147 @top_srcdir@/include/opus_defines.h \ 148 @top_srcdir@/include/opus_multistream.h \ 149 @top_srcdir@/include/opus_custom.h 150 151# The EXCLUDE tag can be used to specify files and/or directories that should be 152# excluded from the INPUT source files. This way you can easily exclude a 153# subdirectory from a directory tree whose root is specified with the INPUT tag. 154# 155# Note that relative paths are relative to the directory from which doxygen is 156# run. 157 158EXCLUDE = 159 160#--------------------------------------------------------------------------- 161# Configuration options related to the alphabetical class index 162#--------------------------------------------------------------------------- 163 164# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 165# compounds will be generated. Enable this if the project contains a lot of 166# classes, structs, unions or interfaces. 167# The default value is: YES. 168 169ALPHABETICAL_INDEX = NO 170 171#--------------------------------------------------------------------------- 172# Configuration options related to the HTML output 173#--------------------------------------------------------------------------- 174 175# The HTML_HEADER tag can be used to specify a user-defined HTML header file for 176# each generated HTML page. If the tag is left blank doxygen will generate a 177# standard header. 178# 179# To get valid HTML the header file that includes any scripts and style sheets 180# that doxygen needs, which is dependent on the configuration options used (e.g. 181# the setting GENERATE_TREEVIEW). It is highly recommended to start with a 182# default header using 183# doxygen -w html new_header.html new_footer.html new_stylesheet.css 184# YourConfigFile 185# and then modify the file new_header.html. See also section "Doxygen usage" 186# for information on how to generate the default header that doxygen normally 187# uses. 188# Note: The header is subject to change so you typically have to regenerate the 189# default header when upgrading to a newer version of doxygen. For a description 190# of the possible markers and block names see the documentation. 191# This tag requires that the tag GENERATE_HTML is set to YES. 192 193HTML_HEADER = @top_srcdir@/doc/header.html 194 195# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 196# generated HTML page. If the tag is left blank doxygen will generate a standard 197# footer. See HTML_HEADER for more information on how to generate a default 198# footer and what special commands can be used inside the footer. See also 199# section "Doxygen usage" for information on how to generate the default footer 200# that doxygen normally uses. 201# This tag requires that the tag GENERATE_HTML is set to YES. 202 203HTML_FOOTER = @top_srcdir@/doc/footer.html 204 205# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 206# sheet that is used by each HTML page. It can be used to fine-tune the look of 207# the HTML output. If left blank doxygen will generate a default style sheet. 208# See also section "Doxygen usage" for information on how to generate the style 209# sheet that doxygen normally uses. 210# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 211# it is more robust and this tag (HTML_STYLESHEET) will in the future become 212# obsolete. 213# This tag requires that the tag GENERATE_HTML is set to YES. 214 215HTML_STYLESHEET = @top_srcdir@/doc/customdoxygen.css 216 217# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 218# other source files which should be copied to the HTML output directory. Note 219# that these files will be copied to the base HTML output directory. Use the 220# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 221# files. In the HTML_STYLESHEET file, use the file name only. Also note that the 222# files will be copied as-is; there are no commands or markers available. 223# This tag requires that the tag GENERATE_HTML is set to YES. 224 225HTML_EXTRA_FILES = @top_srcdir@/doc/opus_logo.svg 226 227# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 228# in the HTML output. For a value of 0 the output will use grayscales only. A 229# value of 255 will produce the most vivid colors. 230# Minimum value: 0, maximum value: 255, default value: 100. 231# This tag requires that the tag GENERATE_HTML is set to YES. 232 233HTML_COLORSTYLE_SAT = 0 234 235# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 236# page will contain the date and time when the page was generated. Setting this 237# to YES can help to show when doxygen was last run and thus if the 238# documentation is up to date. 239# The default value is: NO. 240# This tag requires that the tag GENERATE_HTML is set to YES. 241 242HTML_TIMESTAMP = YES 243 244# When MathJax is enabled you need to specify the location relative to the HTML 245# output directory using the MATHJAX_RELPATH option. The destination directory 246# should contain the MathJax.js script. For instance, if the mathjax directory 247# is located at the same level as the HTML output directory, then 248# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 249# Content Delivery Network so you can quickly see the result without installing 250# MathJax. However, it is strongly recommended to install a local copy of 251# MathJax from http://www.mathjax.org before deployment. 252# The default value is: http://cdn.mathjax.org/mathjax/latest. 253# This tag requires that the tag USE_MATHJAX is set to YES. 254 255MATHJAX_RELPATH = https://www.mathjax.org/mathjax 256 257#--------------------------------------------------------------------------- 258# Configuration options related to the LaTeX output 259#--------------------------------------------------------------------------- 260 261# The PAPER_TYPE tag can be used to set the paper type that is used by the 262# printer. 263# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 264# 14 inches) and executive (7.25 x 10.5 inches). 265# The default value is: a4. 266# This tag requires that the tag GENERATE_LATEX is set to YES. 267 268PAPER_TYPE = letter 269 270#--------------------------------------------------------------------------- 271# Configuration options related to the man page output 272#--------------------------------------------------------------------------- 273 274# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for 275# classes and files. 276# The default value is: NO. 277 278GENERATE_MAN = YES 279 280#--------------------------------------------------------------------------- 281# Configuration options related to the preprocessor 282#--------------------------------------------------------------------------- 283 284# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names 285# in the source code. If set to NO, only conditional compilation will be 286# performed. Macro expansion can be done in a controlled way by setting 287# EXPAND_ONLY_PREDEF to YES. 288# The default value is: NO. 289# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 290 291MACRO_EXPANSION = YES 292 293# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then 294# the macro expansion is limited to the macros specified with the PREDEFINED and 295# EXPAND_AS_DEFINED tags. 296# The default value is: NO. 297# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 298 299EXPAND_ONLY_PREDEF = YES 300 301# The INCLUDE_PATH tag can be used to specify one or more directories that 302# contain include files that are not input files but should be processed by the 303# preprocessor. 304# This tag requires that the tag SEARCH_INCLUDES is set to YES. 305 306INCLUDE_PATH = 307 308# The PREDEFINED tag can be used to specify one or more macro names that are 309# defined before the preprocessor is started (similar to the -D option of e.g. 310# gcc). The argument of the tag is a list of macros of the form: name or 311# name=definition (no spaces). If the definition and the "=" are omitted, "=1" 312# is assumed. To prevent a macro definition from being undefined via #undef or 313# recursively expanded use the := operator instead of the = operator. 314# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. 315 316PREDEFINED = OPUS_EXPORT= \ 317 OPUS_CUSTOM_EXPORT= \ 318 OPUS_CUSTOM_EXPORT_STATIC= \ 319 OPUS_WARN_UNUSED_RESULT= \ 320 OPUS_ARG_NONNULL(_x)= 321 322#--------------------------------------------------------------------------- 323# Configuration options related to the dot tool 324#--------------------------------------------------------------------------- 325 326# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 327# available from the path. This tool is part of Graphviz (see: 328# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent 329# Bell Labs. 330 331# Debian defaults to YES here, while Fedora and Homebrew default to NO. 332# So we set this based on whether the graphviz package is available at 333# configure time. 334# 335HAVE_DOT = @HAVE_DOT@ 336
