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