libs/Music/Doxyfile

   1 # Doxyfile 1.3.7
   2
   3 #---------------------------------------------------------------------------
   4 # Project related configuration options
   5 #---------------------------------------------------------------------------
   6 PROJECT_NAME           = libMusic
   7 PROJECT_NUMBER         =
   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       =
  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 MULTILINE_CPP_IS_BRIEF = NO
  23 DETAILS_AT_TOP         = NO
  24 INHERIT_DOCS           = YES
  25 DISTRIBUTE_GROUP_DOC   = NO
  26 TAB_SIZE               = 8
  27 ALIASES                =
  28 OPTIMIZE_OUTPUT_FOR_C  = NO
  29 OPTIMIZE_OUTPUT_JAVA   = NO
  30 SUBGROUPING            = YES
  31 #---------------------------------------------------------------------------
  32 # Build related configuration options
  33 #---------------------------------------------------------------------------
  34 EXTRACT_ALL            = YES
  35 EXTRACT_PRIVATE        = NO
  36 EXTRACT_STATIC         = YES
  37 EXTRACT_LOCAL_CLASSES  = YES
  38 EXTRACT_LOCAL_METHODS  = NO
  39 HIDE_UNDOC_MEMBERS     = YES
  40 HIDE_UNDOC_CLASSES     = YES
  41 HIDE_FRIEND_COMPOUNDS  = NO
  42 HIDE_IN_BODY_DOCS      = NO
  43 INTERNAL_DOCS          = NO
  44 CASE_SENSE_NAMES       = YES
  45 HIDE_SCOPE_NAMES       = YES
  46 SHOW_INCLUDE_FILES     = NO
  47 INLINE_INFO            = YES
  48 SORT_MEMBER_DOCS       = NO
  49 SORT_BRIEF_DOCS        = NO
  50 SORT_BY_SCOPE_NAME     = NO
  51 GENERATE_TODOLIST      = YES
  52 GENERATE_TESTLIST      = YES
  53 GENERATE_BUGLIST       = YES
  54 GENERATE_DEPRECATEDLIST= YES
  55 ENABLED_SECTIONS       =
  56 MAX_INITIALIZER_LINES  = 30
  57 SHOW_USED_FILES        = YES
  58 #---------------------------------------------------------------------------
  59 # configuration options related to warning and progress messages
  60 #---------------------------------------------------------------------------
  61 QUIET                  = NO
  62 WARNINGS               = YES
  63 WARN_IF_UNDOCUMENTED   = YES
  64 WARN_IF_DOC_ERROR      = YES
  65 WARN_FORMAT            = "$file:$line: $text"
  66 WARN_LOGFILE           =
  67 #---------------------------------------------------------------------------
  68 # configuration options related to the input files
  69 #---------------------------------------------------------------------------
  70 INPUT                  = ./Convolution.h \
  71                          ./Correlation.h \
  72                          ./Instrument.h \
  73                          ./Music.h \
  74                          ./ScoreGenerator.h \
  75                          ./Algorithm.h \
  76                          ./TimeAnalysis.h \
  77                          ./FreqAnalysis.h \
  78                          ./omidistream.h
  79 FILE_PATTERNS          =
  80 RECURSIVE              = NO
  81 EXCLUDE                =
  82 EXCLUDE_SYMLINKS       = NO
  83 EXCLUDE_PATTERNS       =
  84 EXAMPLE_PATH           =
  85 EXAMPLE_PATTERNS       =
  86 EXAMPLE_RECURSIVE      = NO
  87 IMAGE_PATH             =
  88 INPUT_FILTER           =
  89 FILTER_SOURCE_FILES    = NO
  90 #---------------------------------------------------------------------------
  91 # configuration options related to source browsing
  92 #---------------------------------------------------------------------------
  93 SOURCE_BROWSER         = NO
  94 INLINE_SOURCES         = NO
  95 STRIP_CODE_COMMENTS    = YES
  96 REFERENCED_BY_RELATION = YES
  97 REFERENCES_RELATION    = YES
  98 VERBATIM_HEADERS       = YES
  99 #---------------------------------------------------------------------------
 100 # configuration options related to the alphabetical class index
 101 #---------------------------------------------------------------------------
 102 ALPHABETICAL_INDEX     = YES
 103 COLS_IN_ALPHA_INDEX    = 5
 104 IGNORE_PREFIX          =
 105 #---------------------------------------------------------------------------
 106 # configuration options related to the HTML output
 107 #---------------------------------------------------------------------------
 108 GENERATE_HTML          = YES
 109 HTML_OUTPUT            = html
 110 HTML_FILE_EXTENSION    = .html
 111 HTML_HEADER            =
 112 HTML_FOOTER            =
 113 HTML_STYLESHEET        =
 114 HTML_ALIGN_MEMBERS     = YES
 115 GENERATE_HTMLHELP      = NO
 116 CHM_FILE               =
 117 HHC_LOCATION           =
 118 GENERATE_CHI           = NO
 119 BINARY_TOC             = NO
 120 TOC_EXPAND             = NO
 121 DISABLE_INDEX          = NO
 122 ENUM_VALUES_PER_LINE   = 4
 123 GENERATE_TREEVIEW      = YES
 124 TREEVIEW_WIDTH         = 250
 125 #---------------------------------------------------------------------------
 126 # configuration options related to the LaTeX output
 127 #---------------------------------------------------------------------------
 128 GENERATE_LATEX         = NO
 129 LATEX_OUTPUT           = latex
 130 LATEX_CMD_NAME         = latex
 131 MAKEINDEX_CMD_NAME     = makeindex
 132 COMPACT_LATEX          = NO
 133 PAPER_TYPE             = a4wide
 134 EXTRA_PACKAGES         =
 135 LATEX_HEADER           =
 136 PDF_HYPERLINKS         = NO
 137 USE_PDFLATEX           = NO
 138 LATEX_BATCHMODE        = NO
 139 LATEX_HIDE_INDICES     = NO
 140 #---------------------------------------------------------------------------
 141 # configuration options related to the RTF output
 142 #---------------------------------------------------------------------------
 143 GENERATE_RTF           = NO
 144 RTF_OUTPUT             = rtf
 145 COMPACT_RTF            = NO
 146 RTF_HYPERLINKS         = NO
 147 RTF_STYLESHEET_FILE    =
 148 RTF_EXTENSIONS_FILE    =
 149 #---------------------------------------------------------------------------
 150 # configuration options related to the man page output
 151 #---------------------------------------------------------------------------
 152 GENERATE_MAN           = YES
 153 MAN_OUTPUT             = man
 154 MAN_EXTENSION          = .3
 155 MAN_LINKS              = NO
 156 #---------------------------------------------------------------------------
 157 # configuration options related to the XML output
 158 #---------------------------------------------------------------------------
 159 GENERATE_XML           = NO
 160 XML_OUTPUT             = xml
 161 XML_SCHEMA             =
 162 XML_DTD                =
 163 XML_PROGRAMLISTING     = YES
 164 #---------------------------------------------------------------------------
 165 # configuration options for the AutoGen Definitions output
 166 #---------------------------------------------------------------------------
 167 GENERATE_AUTOGEN_DEF   = NO
 168 #---------------------------------------------------------------------------
 169 # configuration options related to the Perl module output
 170 #---------------------------------------------------------------------------
 171 GENERATE_PERLMOD       = NO
 172 PERLMOD_LATEX          = NO
 173 PERLMOD_PRETTY         = YES
 174 PERLMOD_MAKEVAR_PREFIX =
 175 #---------------------------------------------------------------------------
 176 # Configuration options related to the preprocessor
 177 #---------------------------------------------------------------------------
 178 ENABLE_PREPROCESSING   = YES
 179 MACRO_EXPANSION        = NO
 180 EXPAND_ONLY_PREDEF     = NO
 181 SEARCH_INCLUDES        = YES
 182 INCLUDE_PATH           =
 183 INCLUDE_FILE_PATTERNS  =
 184 PREDEFINED             =
 185 EXPAND_AS_DEFINED      =
 186 SKIP_FUNCTION_MACROS   = YES
 187 #---------------------------------------------------------------------------
 188 # Configuration::additions related to external references
 189 #---------------------------------------------------------------------------
 190 TAGFILES               =
 191 GENERATE_TAGFILE       =
 192 ALLEXTERNALS           = NO
 193 EXTERNAL_GROUPS        = YES
 194 PERL_PATH              = /usr/bin/perl
 195 #---------------------------------------------------------------------------
 196 # Configuration options related to the dot tool
 197 #---------------------------------------------------------------------------
 198 CLASS_DIAGRAMS         = YES
 199 HIDE_UNDOC_RELATIONS   = NO
 200 HAVE_DOT               = YES
 201 CLASS_GRAPH            = YES
 202 COLLABORATION_GRAPH    = NO
 203 UML_LOOK               = NO
 204 TEMPLATE_RELATIONS     = YES
 205 INCLUDE_GRAPH          = YES
 206 INCLUDED_BY_GRAPH      = NO
 207 CALL_GRAPH             = NO
 208 GRAPHICAL_HIERARCHY    = YES
 209 DOT_IMAGE_FORMAT       = png
 210 DOT_PATH               =
 211 DOTFILE_DIRS           =
 212 MAX_DOT_GRAPH_WIDTH    = 1024
 213 MAX_DOT_GRAPH_HEIGHT   = 1024
 214 MAX_DOT_GRAPH_DEPTH    = 0
 215 GENERATE_LEGEND        = YES
 216 DOT_CLEANUP            = YES
 217 #---------------------------------------------------------------------------
 218 # Configuration::additions related to the search engine
 219 #---------------------------------------------------------------------------
 220 SEARCHENGINE           = NO