annotate src/portaudio/Doxyfile @ 25:7c42c2fc4173

Add Vamp SDK for OS/X
author Chris Cannam
date Thu, 09 Jan 2014 09:17:21 +0000
parents e13257ea84a4
children
rev   line source
Chris@4 1 # Doxyfile 1.4.6
Chris@4 2
Chris@4 3 #---------------------------------------------------------------------------
Chris@4 4 # Project related configuration options
Chris@4 5 #---------------------------------------------------------------------------
Chris@4 6 PROJECT_NAME = PortAudio
Chris@4 7 PROJECT_NUMBER = 2.0
Chris@4 8 OUTPUT_DIRECTORY = ./doc/
Chris@4 9 CREATE_SUBDIRS = NO
Chris@4 10 OUTPUT_LANGUAGE = English
Chris@4 11 USE_WINDOWS_ENCODING = NO
Chris@4 12 BRIEF_MEMBER_DESC = YES
Chris@4 13 REPEAT_BRIEF = YES
Chris@4 14 ABBREVIATE_BRIEF = "The $name class" \
Chris@4 15 "The $name widget" \
Chris@4 16 "The $name file" \
Chris@4 17 is \
Chris@4 18 provides \
Chris@4 19 specifies \
Chris@4 20 contains \
Chris@4 21 represents \
Chris@4 22 a \
Chris@4 23 an \
Chris@4 24 the
Chris@4 25 ALWAYS_DETAILED_SEC = NO
Chris@4 26 INLINE_INHERITED_MEMB = NO
Chris@4 27 FULL_PATH_NAMES = NO
Chris@4 28 STRIP_FROM_PATH =
Chris@4 29 STRIP_FROM_INC_PATH =
Chris@4 30 SHORT_NAMES = NO
Chris@4 31 JAVADOC_AUTOBRIEF = NO
Chris@4 32 MULTILINE_CPP_IS_BRIEF = NO
Chris@4 33 DETAILS_AT_TOP = NO
Chris@4 34 INHERIT_DOCS = YES
Chris@4 35 SEPARATE_MEMBER_PAGES = NO
Chris@4 36 TAB_SIZE = 8
Chris@4 37 ALIASES =
Chris@4 38 OPTIMIZE_OUTPUT_FOR_C = YES
Chris@4 39 OPTIMIZE_OUTPUT_JAVA = NO
Chris@4 40 BUILTIN_STL_SUPPORT = NO
Chris@4 41 DISTRIBUTE_GROUP_DOC = NO
Chris@4 42 SUBGROUPING = YES
Chris@4 43 #---------------------------------------------------------------------------
Chris@4 44 # Build related configuration options
Chris@4 45 #---------------------------------------------------------------------------
Chris@4 46 EXTRACT_ALL = NO
Chris@4 47 EXTRACT_PRIVATE = NO
Chris@4 48 EXTRACT_STATIC = NO
Chris@4 49 EXTRACT_LOCAL_CLASSES = YES
Chris@4 50 EXTRACT_LOCAL_METHODS = NO
Chris@4 51 HIDE_UNDOC_MEMBERS = NO
Chris@4 52 HIDE_UNDOC_CLASSES = NO
Chris@4 53 HIDE_FRIEND_COMPOUNDS = NO
Chris@4 54 HIDE_IN_BODY_DOCS = NO
Chris@4 55 INTERNAL_DOCS = NO
Chris@4 56 CASE_SENSE_NAMES = YES
Chris@4 57 HIDE_SCOPE_NAMES = NO
Chris@4 58 SHOW_INCLUDE_FILES = YES
Chris@4 59 INLINE_INFO = YES
Chris@4 60 SORT_MEMBER_DOCS = YES
Chris@4 61 SORT_BRIEF_DOCS = NO
Chris@4 62 SORT_BY_SCOPE_NAME = NO
Chris@4 63 GENERATE_TODOLIST = NO
Chris@4 64 GENERATE_TESTLIST = NO
Chris@4 65 GENERATE_BUGLIST = NO
Chris@4 66 GENERATE_DEPRECATEDLIST= YES
Chris@4 67 ENABLED_SECTIONS =
Chris@4 68 MAX_INITIALIZER_LINES = 30
Chris@4 69 SHOW_USED_FILES = YES
Chris@4 70 SHOW_DIRECTORIES = YES
Chris@4 71 FILE_VERSION_FILTER =
Chris@4 72 #---------------------------------------------------------------------------
Chris@4 73 # configuration options related to warning and progress messages
Chris@4 74 #---------------------------------------------------------------------------
Chris@4 75 QUIET = NO
Chris@4 76 WARNINGS = YES
Chris@4 77 WARN_IF_UNDOCUMENTED = YES
Chris@4 78 WARN_IF_DOC_ERROR = YES
Chris@4 79 WARN_NO_PARAMDOC = NO
Chris@4 80 WARN_FORMAT = "$file:$line: $text"
Chris@4 81 WARN_LOGFILE =
Chris@4 82 #---------------------------------------------------------------------------
Chris@4 83 # configuration options related to the input files
Chris@4 84 #---------------------------------------------------------------------------
Chris@4 85 INPUT = doc/src \
Chris@4 86 include \
Chris@4 87 examples
Chris@4 88 FILE_PATTERNS = *.h \
Chris@4 89 *.c \
Chris@4 90 *.cpp \
Chris@4 91 *.dox
Chris@4 92 RECURSIVE = YES
Chris@4 93 EXCLUDE = src/hostapi/wasapi/mingw-include
Chris@4 94 EXCLUDE_SYMLINKS = NO
Chris@4 95 EXCLUDE_PATTERNS =
Chris@4 96 EXAMPLE_PATH =
Chris@4 97 EXAMPLE_PATTERNS =
Chris@4 98 EXAMPLE_RECURSIVE = NO
Chris@4 99 IMAGE_PATH = doc/src/images
Chris@4 100 INPUT_FILTER =
Chris@4 101 FILTER_PATTERNS =
Chris@4 102 FILTER_SOURCE_FILES = NO
Chris@4 103 #---------------------------------------------------------------------------
Chris@4 104 # configuration options related to source browsing
Chris@4 105 #---------------------------------------------------------------------------
Chris@4 106 SOURCE_BROWSER = YES
Chris@4 107 INLINE_SOURCES = NO
Chris@4 108 STRIP_CODE_COMMENTS = YES
Chris@4 109 REFERENCED_BY_RELATION = YES
Chris@4 110 REFERENCES_RELATION = YES
Chris@4 111 USE_HTAGS = NO
Chris@4 112 VERBATIM_HEADERS = YES
Chris@4 113 #---------------------------------------------------------------------------
Chris@4 114 # configuration options related to the alphabetical class index
Chris@4 115 #---------------------------------------------------------------------------
Chris@4 116 ALPHABETICAL_INDEX = NO
Chris@4 117 COLS_IN_ALPHA_INDEX = 5
Chris@4 118 IGNORE_PREFIX =
Chris@4 119 #---------------------------------------------------------------------------
Chris@4 120 # configuration options related to the HTML output
Chris@4 121 #---------------------------------------------------------------------------
Chris@4 122 GENERATE_HTML = YES
Chris@4 123 HTML_OUTPUT = html
Chris@4 124 HTML_FILE_EXTENSION = .html
Chris@4 125 HTML_HEADER =
Chris@4 126 HTML_FOOTER =
Chris@4 127 HTML_STYLESHEET =
Chris@4 128 HTML_ALIGN_MEMBERS = YES
Chris@4 129 GENERATE_HTMLHELP = NO
Chris@4 130 CHM_FILE =
Chris@4 131 HHC_LOCATION =
Chris@4 132 GENERATE_CHI = NO
Chris@4 133 BINARY_TOC = NO
Chris@4 134 TOC_EXPAND = NO
Chris@4 135 DISABLE_INDEX = NO
Chris@4 136 ENUM_VALUES_PER_LINE = 4
Chris@4 137 GENERATE_TREEVIEW = NO
Chris@4 138 TREEVIEW_WIDTH = 250
Chris@4 139 #---------------------------------------------------------------------------
Chris@4 140 # configuration options related to the LaTeX output
Chris@4 141 #---------------------------------------------------------------------------
Chris@4 142 GENERATE_LATEX = NO
Chris@4 143 LATEX_OUTPUT = latex
Chris@4 144 LATEX_CMD_NAME = latex
Chris@4 145 MAKEINDEX_CMD_NAME = makeindex
Chris@4 146 COMPACT_LATEX = NO
Chris@4 147 PAPER_TYPE = a4wide
Chris@4 148 EXTRA_PACKAGES =
Chris@4 149 LATEX_HEADER =
Chris@4 150 PDF_HYPERLINKS = NO
Chris@4 151 USE_PDFLATEX = NO
Chris@4 152 LATEX_BATCHMODE = NO
Chris@4 153 LATEX_HIDE_INDICES = NO
Chris@4 154 #---------------------------------------------------------------------------
Chris@4 155 # configuration options related to the RTF output
Chris@4 156 #---------------------------------------------------------------------------
Chris@4 157 GENERATE_RTF = NO
Chris@4 158 RTF_OUTPUT = rtf
Chris@4 159 COMPACT_RTF = NO
Chris@4 160 RTF_HYPERLINKS = NO
Chris@4 161 RTF_STYLESHEET_FILE =
Chris@4 162 RTF_EXTENSIONS_FILE =
Chris@4 163 #---------------------------------------------------------------------------
Chris@4 164 # configuration options related to the man page output
Chris@4 165 #---------------------------------------------------------------------------
Chris@4 166 GENERATE_MAN = NO
Chris@4 167 MAN_OUTPUT = man
Chris@4 168 MAN_EXTENSION = .3
Chris@4 169 MAN_LINKS = NO
Chris@4 170 #---------------------------------------------------------------------------
Chris@4 171 # configuration options related to the XML output
Chris@4 172 #---------------------------------------------------------------------------
Chris@4 173 GENERATE_XML = NO
Chris@4 174 XML_OUTPUT = xml
Chris@4 175 XML_SCHEMA =
Chris@4 176 XML_DTD =
Chris@4 177 XML_PROGRAMLISTING = YES
Chris@4 178 #---------------------------------------------------------------------------
Chris@4 179 # configuration options for the AutoGen Definitions output
Chris@4 180 #---------------------------------------------------------------------------
Chris@4 181 GENERATE_AUTOGEN_DEF = NO
Chris@4 182 #---------------------------------------------------------------------------
Chris@4 183 # configuration options related to the Perl module output
Chris@4 184 #---------------------------------------------------------------------------
Chris@4 185 GENERATE_PERLMOD = NO
Chris@4 186 PERLMOD_LATEX = NO
Chris@4 187 PERLMOD_PRETTY = YES
Chris@4 188 PERLMOD_MAKEVAR_PREFIX =
Chris@4 189 #---------------------------------------------------------------------------
Chris@4 190 # Configuration options related to the preprocessor
Chris@4 191 #---------------------------------------------------------------------------
Chris@4 192 ENABLE_PREPROCESSING = YES
Chris@4 193 MACRO_EXPANSION = NO
Chris@4 194 EXPAND_ONLY_PREDEF = NO
Chris@4 195 SEARCH_INCLUDES = YES
Chris@4 196 INCLUDE_PATH =
Chris@4 197 INCLUDE_FILE_PATTERNS =
Chris@4 198 PREDEFINED =
Chris@4 199 EXPAND_AS_DEFINED =
Chris@4 200 SKIP_FUNCTION_MACROS = YES
Chris@4 201 #---------------------------------------------------------------------------
Chris@4 202 # Configuration::additions related to external references
Chris@4 203 #---------------------------------------------------------------------------
Chris@4 204 TAGFILES =
Chris@4 205 GENERATE_TAGFILE =
Chris@4 206 ALLEXTERNALS = NO
Chris@4 207 EXTERNAL_GROUPS = YES
Chris@4 208 PERL_PATH = /usr/bin/perl
Chris@4 209 #---------------------------------------------------------------------------
Chris@4 210 # Configuration options related to the dot tool
Chris@4 211 #---------------------------------------------------------------------------
Chris@4 212 CLASS_DIAGRAMS = NO
Chris@4 213 HIDE_UNDOC_RELATIONS = NO
Chris@4 214 HAVE_DOT = NO
Chris@4 215 CLASS_GRAPH = YES
Chris@4 216 COLLABORATION_GRAPH = YES
Chris@4 217 GROUP_GRAPHS = YES
Chris@4 218 UML_LOOK = NO
Chris@4 219 TEMPLATE_RELATIONS = YES
Chris@4 220 INCLUDE_GRAPH = YES
Chris@4 221 INCLUDED_BY_GRAPH = YES
Chris@4 222 CALL_GRAPH = NO
Chris@4 223 GRAPHICAL_HIERARCHY = YES
Chris@4 224 DIRECTORY_GRAPH = YES
Chris@4 225 DOT_IMAGE_FORMAT = png
Chris@4 226 DOT_PATH =
Chris@4 227 DOTFILE_DIRS =
Chris@4 228 MAX_DOT_GRAPH_WIDTH = 1024
Chris@4 229 MAX_DOT_GRAPH_HEIGHT = 1024
Chris@4 230 MAX_DOT_GRAPH_DEPTH = 1000
Chris@4 231 DOT_TRANSPARENT = NO
Chris@4 232 DOT_MULTI_TARGETS = NO
Chris@4 233 GENERATE_LEGEND = YES
Chris@4 234 DOT_CLEANUP = YES
Chris@4 235 #---------------------------------------------------------------------------
Chris@4 236 # Configuration::additions related to the search engine
Chris@4 237 #---------------------------------------------------------------------------
Chris@4 238 SEARCHENGINE = NO