doc/doxygen/Doxyfile

   1 # Doxyfile 1.5.6
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 DOXYFILE_ENCODING      = UTF-8
   7 PROJECT_NAME           = RtAudio
   8 PROJECT_NUMBER         = 4.0.5
   9 OUTPUT_DIRECTORY       = .
  10 CREATE_SUBDIRS         = NO
  11 OUTPUT_LANGUAGE        = English
  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 QT_AUTOBRIEF           = NO
  33 MULTILINE_CPP_IS_BRIEF = NO
  34 DETAILS_AT_TOP         = NO
  35 INHERIT_DOCS           = YES
  36 SEPARATE_MEMBER_PAGES  = NO
  37 TAB_SIZE               = 8
  38 ALIASES                =
  39 OPTIMIZE_OUTPUT_FOR_C  = NO
  40 OPTIMIZE_OUTPUT_JAVA   = NO
  41 OPTIMIZE_FOR_FORTRAN   = NO
  42 OPTIMIZE_OUTPUT_VHDL   = NO
  43 BUILTIN_STL_SUPPORT    = NO
  44 CPP_CLI_SUPPORT        = NO
  45 SIP_SUPPORT            = NO
  46 IDL_PROPERTY_SUPPORT   = YES
  47 DISTRIBUTE_GROUP_DOC   = NO
  48 SUBGROUPING            = YES
  49 TYPEDEF_HIDES_STRUCT   = NO
  50 #---------------------------------------------------------------------------
  51 # Build related configuration options
  52 #---------------------------------------------------------------------------
  53 EXTRACT_ALL            = NO
  54 EXTRACT_PRIVATE        = NO
  55 EXTRACT_STATIC         = NO
  56 EXTRACT_LOCAL_CLASSES  = YES
  57 EXTRACT_LOCAL_METHODS  = NO
  58 EXTRACT_ANON_NSPACES   = NO
  59 HIDE_UNDOC_MEMBERS     = YES
  60 HIDE_UNDOC_CLASSES     = YES
  61 HIDE_FRIEND_COMPOUNDS  = NO
  62 HIDE_IN_BODY_DOCS      = NO
  63 INTERNAL_DOCS          = NO
  64 CASE_SENSE_NAMES       = YES
  65 HIDE_SCOPE_NAMES       = NO
  66 SHOW_INCLUDE_FILES     = YES
  67 INLINE_INFO            = YES
  68 SORT_MEMBER_DOCS       = NO
  69 SORT_BRIEF_DOCS        = NO
  70 SORT_GROUP_NAMES       = NO
  71 SORT_BY_SCOPE_NAME     = NO
  72 GENERATE_TODOLIST      = YES
  73 GENERATE_TESTLIST      = YES
  74 GENERATE_BUGLIST       = YES
  75 GENERATE_DEPRECATEDLIST= YES
  76 ENABLED_SECTIONS       =
  77 MAX_INITIALIZER_LINES  = 30
  78 SHOW_USED_FILES        = YES
  79 SHOW_DIRECTORIES       = NO
  80 SHOW_FILES             = YES
  81 SHOW_NAMESPACES        = YES
  82 FILE_VERSION_FILTER    =
  83 #---------------------------------------------------------------------------
  84 # configuration options related to warning and progress messages
  85 #---------------------------------------------------------------------------
  86 QUIET                  = NO
  87 WARNINGS               = YES
  88 WARN_IF_UNDOCUMENTED   = YES
  89 WARN_IF_DOC_ERROR      = YES
  90 WARN_NO_PARAMDOC       = NO
  91 WARN_FORMAT            = "$file:$line: $text"
  92 WARN_LOGFILE           =
  93 #---------------------------------------------------------------------------
  94 # configuration options related to the input files
  95 #---------------------------------------------------------------------------
  96 INPUT                  = . \
  97                          ../../RtAudio.h \
  98                          ../../RtError.h
  99 INPUT_ENCODING         = UTF-8
 100 FILE_PATTERNS          = *.txt
 101 RECURSIVE              = NO
 102 EXCLUDE                =
 103 EXCLUDE_SYMLINKS       = NO
 104 EXCLUDE_PATTERNS       =
 105 EXCLUDE_SYMBOLS        =
 106 EXAMPLE_PATH           = ../../tests/
 107 EXAMPLE_PATTERNS       =
 108 EXAMPLE_RECURSIVE      = NO
 109 IMAGE_PATH             =
 110 INPUT_FILTER           =
 111 FILTER_PATTERNS        =
 112 FILTER_SOURCE_FILES    = NO
 113 #---------------------------------------------------------------------------
 114 # configuration options related to source browsing
 115 #---------------------------------------------------------------------------
 116 SOURCE_BROWSER         = NO
 117 INLINE_SOURCES         = NO
 118 STRIP_CODE_COMMENTS    = YES
 119 REFERENCED_BY_RELATION = YES
 120 REFERENCES_RELATION    = YES
 121 REFERENCES_LINK_SOURCE = YES
 122 USE_HTAGS              = NO
 123 VERBATIM_HEADERS       = YES
 124 #---------------------------------------------------------------------------
 125 # configuration options related to the alphabetical class index
 126 #---------------------------------------------------------------------------
 127 ALPHABETICAL_INDEX     = NO
 128 COLS_IN_ALPHA_INDEX    = 5
 129 IGNORE_PREFIX          =
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the HTML output
 132 #---------------------------------------------------------------------------
 133 GENERATE_HTML          = YES
 134 HTML_OUTPUT            = ../html
 135 HTML_FILE_EXTENSION    = .html
 136 HTML_HEADER            = header.html
 137 HTML_FOOTER            = footer.html
 138 HTML_STYLESHEET        =
 139 HTML_ALIGN_MEMBERS     = YES
 140 GENERATE_HTMLHELP      = NO
 141 GENERATE_DOCSET        = NO
 142 DOCSET_FEEDNAME        = "Doxygen generated docs"
 143 DOCSET_BUNDLE_ID       = org.doxygen.Project
 144 HTML_DYNAMIC_SECTIONS  = NO
 145 CHM_FILE               =
 146 HHC_LOCATION           =
 147 GENERATE_CHI           = NO
 148 CHM_INDEX_ENCODING     =
 149 BINARY_TOC             = NO
 150 TOC_EXPAND             = NO
 151 DISABLE_INDEX          = YES
 152 ENUM_VALUES_PER_LINE   = 4
 153 GENERATE_TREEVIEW      = NO
 154 TREEVIEW_WIDTH         = 250
 155 FORMULA_FONTSIZE       = 10
 156 #---------------------------------------------------------------------------
 157 # configuration options related to the LaTeX output
 158 #---------------------------------------------------------------------------
 159 GENERATE_LATEX         = NO
 160 LATEX_OUTPUT           = latex
 161 LATEX_CMD_NAME         = latex
 162 MAKEINDEX_CMD_NAME     = makeindex
 163 COMPACT_LATEX          = NO
 164 PAPER_TYPE             = letter
 165 EXTRA_PACKAGES         =
 166 LATEX_HEADER           =
 167 PDF_HYPERLINKS         = NO
 168 USE_PDFLATEX           = YES
 169 LATEX_BATCHMODE        = NO
 170 LATEX_HIDE_INDICES     = NO
 171 #---------------------------------------------------------------------------
 172 # configuration options related to the RTF output
 173 #---------------------------------------------------------------------------
 174 GENERATE_RTF           = NO
 175 RTF_OUTPUT             = rtf
 176 COMPACT_RTF            = NO
 177 RTF_HYPERLINKS         = NO
 178 RTF_STYLESHEET_FILE    =
 179 RTF_EXTENSIONS_FILE    =
 180 #---------------------------------------------------------------------------
 181 # configuration options related to the man page output
 182 #---------------------------------------------------------------------------
 183 GENERATE_MAN           = NO
 184 MAN_OUTPUT             = man
 185 MAN_EXTENSION          = .3
 186 MAN_LINKS              = NO
 187 #---------------------------------------------------------------------------
 188 # configuration options related to the XML output
 189 #---------------------------------------------------------------------------
 190 GENERATE_XML           = NO
 191 XML_OUTPUT             = xml
 192 XML_SCHEMA             =
 193 XML_DTD                =
 194 XML_PROGRAMLISTING     = YES
 195 #---------------------------------------------------------------------------
 196 # configuration options for the AutoGen Definitions output
 197 #---------------------------------------------------------------------------
 198 GENERATE_AUTOGEN_DEF   = NO
 199 #---------------------------------------------------------------------------
 200 # configuration options related to the Perl module output
 201 #---------------------------------------------------------------------------
 202 GENERATE_PERLMOD       = NO
 203 PERLMOD_LATEX          = NO
 204 PERLMOD_PRETTY         = YES
 205 PERLMOD_MAKEVAR_PREFIX =
 206 #---------------------------------------------------------------------------
 207 # Configuration options related to the preprocessor
 208 #---------------------------------------------------------------------------
 209 ENABLE_PREPROCESSING   = YES
 210 MACRO_EXPANSION        = NO
 211 EXPAND_ONLY_PREDEF     = NO
 212 SEARCH_INCLUDES        = YES
 213 INCLUDE_PATH           =
 214 INCLUDE_FILE_PATTERNS  =
 215 PREDEFINED             =
 216 EXPAND_AS_DEFINED      =
 217 SKIP_FUNCTION_MACROS   = YES
 218 #---------------------------------------------------------------------------
 219 # Configuration::additions related to external references
 220 #---------------------------------------------------------------------------
 221 TAGFILES               =
 222 GENERATE_TAGFILE       =
 223 ALLEXTERNALS           = NO
 224 EXTERNAL_GROUPS        = YES
 225 PERL_PATH              = /usr/bin/perl
 226 #---------------------------------------------------------------------------
 227 # Configuration options related to the dot tool
 228 #---------------------------------------------------------------------------
 229 CLASS_DIAGRAMS         = YES
 230 MSCGEN_PATH            = /Applications/Doxygen.app/Contents/Resources/
 231 HIDE_UNDOC_RELATIONS   = YES
 232 HAVE_DOT               = NO
 233 DOT_FONTNAME           = FreeSans
 234 DOT_FONTPATH           =
 235 CLASS_GRAPH            = YES
 236 COLLABORATION_GRAPH    = YES
 237 GROUP_GRAPHS           = YES
 238 UML_LOOK               = NO
 239 TEMPLATE_RELATIONS     = NO
 240 INCLUDE_GRAPH          = YES
 241 INCLUDED_BY_GRAPH      = YES
 242 CALL_GRAPH             = NO
 243 CALLER_GRAPH           = NO
 244 GRAPHICAL_HIERARCHY    = YES
 245 DIRECTORY_GRAPH        = YES
 246 DOT_IMAGE_FORMAT       = png
 247 DOT_PATH               = /Applications/Doxygen.app/Contents/Resources/
 248 DOTFILE_DIRS           =
 249 DOT_GRAPH_MAX_NODES    = 50
 250 MAX_DOT_GRAPH_DEPTH    = 0
 251 DOT_TRANSPARENT        = YES
 252 DOT_MULTI_TARGETS      = NO
 253 GENERATE_LEGEND        = YES
 254 DOT_CLEANUP            = YES
 255 #---------------------------------------------------------------------------
 256 # Configuration::additions related to the search engine
 257 #---------------------------------------------------------------------------
 258 SEARCHENGINE           = NO