Doxyfile

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