doc/doxygen/Doxyfile

   1 # Doxyfile 1.2.6
   2
   3 #---------------------------------------------------------------------------
   4 # General configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = RtAudio
   7 PROJECT_NUMBER         =
   8 OUTPUT_DIRECTORY       = .
   9 OUTPUT_LANGUAGE        = English
  10 EXTRACT_ALL            = NO
  11 EXTRACT_PRIVATE        = NO
  12 EXTRACT_STATIC         = NO
  13 HIDE_UNDOC_MEMBERS     = YES
  14 HIDE_UNDOC_CLASSES     = NO
  15 BRIEF_MEMBER_DESC      = YES
  16 REPEAT_BRIEF           = YES
  17 ALWAYS_DETAILED_SEC    = NO
  18 FULL_PATH_NAMES        = NO
  19 STRIP_FROM_PATH        =
  20 INTERNAL_DOCS          = NO
  21 CLASS_DIAGRAMS         = YES
  22 SOURCE_BROWSER         = NO
  23 INLINE_SOURCES         = NO
  24 STRIP_CODE_COMMENTS    = YES
  25 CASE_SENSE_NAMES       = YES
  26 HIDE_SCOPE_NAMES       = NO
  27 VERBATIM_HEADERS       = YES
  28 SHOW_INCLUDE_FILES     = YES
  29 JAVADOC_AUTOBRIEF      = NO
  30 INHERIT_DOCS           = YES
  31 INLINE_INFO            = YES
  32 SORT_MEMBER_DOCS       = NO
  33 DISTRIBUTE_GROUP_DOC   = NO
  34 TAB_SIZE               = 8
  35 ENABLED_SECTIONS       =
  36 GENERATE_TODOLIST      = YES
  37 GENERATE_TESTLIST      = YES
  38 GENERATE_BUGLIST       = YES
  39 ALIASES                =
  40 MAX_INITIALIZER_LINES  = 30
  41 OPTIMIZE_OUTPUT_FOR_C  = NO
  42 SHOW_USED_FILES        = YES
  43 #---------------------------------------------------------------------------
  44 # configuration options related to warning and progress messages
  45 #---------------------------------------------------------------------------
  46 QUIET                  = NO
  47 WARNINGS               = YES
  48 WARN_IF_UNDOCUMENTED   = YES
  49 WARN_FORMAT            = "$file:$line: $text"
  50 WARN_LOGFILE           =
  51 #---------------------------------------------------------------------------
  52 # configuration options related to the input files
  53 #---------------------------------------------------------------------------
  54 INPUT                  = tutorial.txt ../../RtAudio.h
  55 FILE_PATTERNS          =
  56 RECURSIVE              = NO
  57 EXCLUDE                =
  58 EXCLUDE_PATTERNS       =
  59 EXAMPLE_PATH           =
  60 EXAMPLE_PATTERNS       =
  61 IMAGE_PATH             =
  62 INPUT_FILTER           =
  63 FILTER_SOURCE_FILES    = NO
  64 #---------------------------------------------------------------------------
  65 # configuration options related to the alphabetical class index
  66 #---------------------------------------------------------------------------
  67 ALPHABETICAL_INDEX     = NO
  68 COLS_IN_ALPHA_INDEX    = 5
  69 IGNORE_PREFIX          =
  70 #---------------------------------------------------------------------------
  71 # configuration options related to the HTML output
  72 #---------------------------------------------------------------------------
  73 GENERATE_HTML          = YES
  74 HTML_OUTPUT            = ../html
  75 HTML_HEADER            = header.html
  76 HTML_FOOTER            = footer.html
  77 HTML_STYLESHEET        =
  78 HTML_ALIGN_MEMBERS     = YES
  79 GENERATE_HTMLHELP      = NO
  80 GENERATE_CHI           = NO
  81 BINARY_TOC             = NO
  82 TOC_EXPAND             = NO
  83 DISABLE_INDEX          = YES
  84 ENUM_VALUES_PER_LINE   = 4
  85 GENERATE_TREEVIEW      = NO
  86 TREEVIEW_WIDTH         = 250
  87 #---------------------------------------------------------------------------
  88 # configuration options related to the LaTeX output
  89 #---------------------------------------------------------------------------
  90 GENERATE_LATEX         = NO
  91 LATEX_OUTPUT           = latex
  92 COMPACT_LATEX          = NO
  93 PAPER_TYPE             = letter
  94 EXTRA_PACKAGES         =
  95 LATEX_HEADER           =
  96 PDF_HYPERLINKS         = NO
  97 USE_PDFLATEX           = YES
  98 LATEX_BATCHMODE        = NO
  99 #---------------------------------------------------------------------------
 100 # configuration options related to the RTF output
 101 #---------------------------------------------------------------------------
 102 GENERATE_RTF           = NO
 103 RTF_OUTPUT             = rtf
 104 COMPACT_RTF            = NO
 105 RTF_HYPERLINKS         = NO
 106 RTF_STYLESHEET_FILE    =
 107 #---------------------------------------------------------------------------
 108 # configuration options related to the man page output
 109 #---------------------------------------------------------------------------
 110 GENERATE_MAN           = NO
 111 MAN_OUTPUT             = man
 112 MAN_EXTENSION          = .3
 113 #---------------------------------------------------------------------------
 114 # Configuration options related to the preprocessor
 115 #---------------------------------------------------------------------------
 116 ENABLE_PREPROCESSING   = YES
 117 MACRO_EXPANSION        = NO
 118 EXPAND_ONLY_PREDEF     = NO
 119 SEARCH_INCLUDES        = YES
 120 INCLUDE_PATH           =
 121 INCLUDE_FILE_PATTERNS  =
 122 PREDEFINED             =
 123 EXPAND_AS_DEFINED      =
 124 #---------------------------------------------------------------------------
 125 # Configuration::addtions related to external references
 126 #---------------------------------------------------------------------------
 127 TAGFILES               =
 128 GENERATE_TAGFILE       =
 129 ALLEXTERNALS           = NO
 130 PERL_PATH              = /usr/bin/perl
 131 #---------------------------------------------------------------------------
 132 # Configuration options related to the dot tool
 133 #---------------------------------------------------------------------------
 134 HAVE_DOT               = NO
 135 CLASS_GRAPH            = YES
 136 COLLABORATION_GRAPH    = YES
 137 INCLUDE_GRAPH          = YES
 138 INCLUDED_BY_GRAPH      = YES
 139 GRAPHICAL_HIERARCHY    = YES
 140 DOT_PATH               =
 141 MAX_DOT_GRAPH_WIDTH    = 1024
 142 MAX_DOT_GRAPH_HEIGHT   = 1024
 143 GENERATE_LEGEND        = YES
 144 DOT_CLEANUP            = YES
 145 #---------------------------------------------------------------------------
 146 # Configuration::addtions related to the search engine
 147 #---------------------------------------------------------------------------
 148 SEARCHENGINE           = NO
 149 CGI_NAME               = search.cgi
 150 CGI_URL                =
 151 DOC_URL                =
 152 DOC_ABSPATH            =
 153 BIN_ABSPATH            = /usr/local/bin/
 154 EXT_DOC_PATHS          =
 155