libs/audiographer/doc/doxyfile

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