maintenance/Doxyfile

   1 # Doxyfile 1.7.5.1
   2
   3 #
   4 # Some placeholders have been added for MediaWiki usage:
   5 # {{OUTPUT_DIRECTORY}}
   6 # {{CURRENT_VERSION}}
   7 # {{STRIP_FROM_PATH}}
   8 # {{SVNSTAT}}
   9 # {{INPUT}}
  10 #
  11 # To generate documentation run: php mwdocgen.php --no-extensions
  12
  13 #---------------------------------------------------------------------------
  14 # Project related configuration options
  15 #---------------------------------------------------------------------------
  16 DOXYFILE_ENCODING      = UTF-8
  17 PROJECT_NAME           = MediaWiki
  18 PROJECT_NUMBER         = {{CURRENT_VERSION}}
  19 PROJECT_BRIEF          =
  20 PROJECT_LOGO           =
  21 OUTPUT_DIRECTORY       = {{OUTPUT_DIRECTORY}}
  22 CREATE_SUBDIRS         = NO
  23 OUTPUT_LANGUAGE        = English
  24 BRIEF_MEMBER_DESC      = YES
  25 REPEAT_BRIEF           = YES
  26 ABBREVIATE_BRIEF       = "The $name class" \
  27                          "The $name widget" \
  28                          "The $name file" \
  29                          is \
  30                          provides \
  31                          specifies \
  32                          contains \
  33                          represents \
  34                          a \
  35                          an \
  36                          the
  37 ALWAYS_DETAILED_SEC    = NO
  38 INLINE_INHERITED_MEMB  = NO
  39 FULL_PATH_NAMES        = YES
  40 STRIP_FROM_PATH        = {{STRIP_FROM_PATH}}
  41 STRIP_FROM_INC_PATH    =
  42 SHORT_NAMES            = NO
  43 JAVADOC_AUTOBRIEF      = YES
  44 QT_AUTOBRIEF           = NO
  45 MULTILINE_CPP_IS_BRIEF = NO
  46 INHERIT_DOCS           = YES
  47 SEPARATE_MEMBER_PAGES  = NO
  48 TAB_SIZE               = 8
  49 ALIASES =       "type{1}=<b> \1 </b>:" \
  50                 "types{2}=<b> \1 </b> or <b> \2 </b>:" \
  51                 "types{3}=<b> \1 </b>, <b> \2 </b>, or <b> \3 </b>:" \
  52                 "arrayof{2}=<b> Array </b> of \2" \
  53                 "null=\type{Null}" \
  54                 "boolean=\type{Boolean}" \
  55                 "bool=\type{Boolean}" \
  56                 "integer=\type{Integer}" \
  57                 "int=\type{Integer}" \
  58                 "string=\type{String}" \
  59                 "str=\type{String}" \
  60                 "mixed=\type{Mixed}" \
  61                 "access=\par Access:\n" \
  62                 "private=\access private" \
  63                 "protected=\access protected" \
  64                 "public=\access public" \
  65                 "copyright=\note" \
  66                 "license=\note"
  67 OPTIMIZE_OUTPUT_FOR_C  = NO
  68 OPTIMIZE_OUTPUT_JAVA   = NO
  69 OPTIMIZE_FOR_FORTRAN   = NO
  70 OPTIMIZE_OUTPUT_VHDL   = NO
  71 EXTENSION_MAPPING      =
  72 BUILTIN_STL_SUPPORT    = NO
  73 CPP_CLI_SUPPORT        = NO
  74 SIP_SUPPORT            = NO
  75 IDL_PROPERTY_SUPPORT   = NO
  76 DISTRIBUTE_GROUP_DOC   = YES
  77 SUBGROUPING            = YES
  78 INLINE_GROUPED_CLASSES = NO
  79 INLINE_SIMPLE_STRUCTS  = NO
  80 TYPEDEF_HIDES_STRUCT   = NO
  81 SYMBOL_CACHE_SIZE      = 0
  82 #---------------------------------------------------------------------------
  83 # Build related configuration options
  84 #---------------------------------------------------------------------------
  85 EXTRACT_ALL            = YES
  86 EXTRACT_PRIVATE        = YES
  87 EXTRACT_STATIC         = YES
  88 EXTRACT_LOCAL_CLASSES  = YES
  89 EXTRACT_LOCAL_METHODS  = NO
  90 EXTRACT_ANON_NSPACES   = NO
  91 HIDE_UNDOC_MEMBERS     = NO
  92 HIDE_UNDOC_CLASSES     = NO
  93 HIDE_FRIEND_COMPOUNDS  = NO
  94 HIDE_IN_BODY_DOCS      = YES
  95 INTERNAL_DOCS          = NO
  96 CASE_SENSE_NAMES       = YES
  97 HIDE_SCOPE_NAMES       = NO
  98 SHOW_INCLUDE_FILES     = YES
  99 FORCE_LOCAL_INCLUDES   = NO
 100 INLINE_INFO            = YES
 101 SORT_MEMBER_DOCS       = YES
 102 SORT_BRIEF_DOCS        = YES
 103 SORT_MEMBERS_CTORS_1ST = NO
 104 SORT_GROUP_NAMES       = NO
 105 SORT_BY_SCOPE_NAME     = NO
 106 STRICT_PROTO_MATCHING  = NO
 107 GENERATE_TODOLIST      = YES
 108 GENERATE_TESTLIST      = YES
 109 GENERATE_BUGLIST       = YES
 110 GENERATE_DEPRECATEDLIST= YES
 111 ENABLED_SECTIONS       =
 112 MAX_INITIALIZER_LINES  = 30
 113 SHOW_USED_FILES        = YES
 114 SHOW_DIRECTORIES       = YES
 115 SHOW_FILES             = YES
 116 SHOW_NAMESPACES        = NO
 117 FILE_VERSION_FILTER    = {{SVNSTAT}}
 118 LAYOUT_FILE            =
 119 CITE_BIB_FILES         =
 120 #---------------------------------------------------------------------------
 121 # configuration options related to warning and progress messages
 122 #---------------------------------------------------------------------------
 123 QUIET                  = NO
 124 WARNINGS               = YES
 125 WARN_IF_UNDOCUMENTED   = YES
 126 WARN_IF_DOC_ERROR      = YES
 127 WARN_NO_PARAMDOC       = NO
 128 WARN_FORMAT            = "$file:$line: $text"
 129 WARN_LOGFILE           =
 130 #---------------------------------------------------------------------------
 131 # configuration options related to the input files
 132 #---------------------------------------------------------------------------
 133 INPUT                  = {{INPUT}}
 134 INPUT_ENCODING         = UTF-8
 135 FILE_PATTERNS          = *.c \
 136                          *.cc \
 137                          *.cxx \
 138                          *.cpp \
 139                          *.c++ \
 140                          *.d \
 141                          *.java \
 142                          *.ii \
 143                          *.ixx \
 144                          *.ipp \
 145                          *.i++ \
 146                          *.inl \
 147                          *.h \
 148                          *.hh \
 149                          *.hxx \
 150                          *.hpp \
 151                          *.h++ \
 152                          *.idl \
 153                          *.odl \
 154                          *.cs \
 155                          *.php \
 156                          *.php5 \
 157                          *.inc \
 158                          *.m \
 159                          *.mm \
 160                          *.dox \
 161                          *.py \
 162                          *.C \
 163                          *.CC \
 164                          *.C++ \
 165                          *.II \
 166                          *.I++ \
 167                          *.H \
 168                          *.HH \
 169                          *.H++ \
 170                          *.CS \
 171                          *.PHP \
 172                          *.PHP5 \
 173                          *.M \
 174                          *.MM \
 175                          *.PY
 176 RECURSIVE              = YES
 177 EXCLUDE                = {{EXCLUDE}}
 178 EXCLUDE_SYMLINKS       = YES
 179 EXCLUDE_PATTERNS       = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
 180 EXCLUDE_SYMBOLS        =
 181 EXAMPLE_PATH           =
 182 EXAMPLE_PATTERNS       = *
 183 EXAMPLE_RECURSIVE      = NO
 184 IMAGE_PATH             =
 185 INPUT_FILTER           =
 186 FILTER_PATTERNS        =
 187 FILTER_SOURCE_FILES    = NO
 188 FILTER_SOURCE_PATTERNS =
 189 #---------------------------------------------------------------------------
 190 # configuration options related to source browsing
 191 #---------------------------------------------------------------------------
 192 SOURCE_BROWSER         = YES
 193 INLINE_SOURCES         = NO
 194 STRIP_CODE_COMMENTS    = YES
 195 REFERENCED_BY_RELATION = YES
 196 REFERENCES_RELATION    = YES
 197 REFERENCES_LINK_SOURCE = YES
 198 USE_HTAGS              = NO
 199 VERBATIM_HEADERS       = YES
 200 #---------------------------------------------------------------------------
 201 # configuration options related to the alphabetical class index
 202 #---------------------------------------------------------------------------
 203 ALPHABETICAL_INDEX     = NO
 204 COLS_IN_ALPHA_INDEX    = 5
 205 IGNORE_PREFIX          =
 206 #---------------------------------------------------------------------------
 207 # configuration options related to the HTML output
 208 #---------------------------------------------------------------------------
 209 GENERATE_HTML          = YES
 210 HTML_OUTPUT            = html
 211 HTML_FILE_EXTENSION    = .html
 212 HTML_HEADER            =
 213 HTML_FOOTER            =
 214 HTML_STYLESHEET        =
 215 HTML_EXTRA_FILES       =
 216 HTML_COLORSTYLE_HUE    = 220
 217 HTML_COLORSTYLE_SAT    = 100
 218 HTML_COLORSTYLE_GAMMA  =  80
 219 HTML_TIMESTAMP         = YES
 220 HTML_ALIGN_MEMBERS     = YES
 221 HTML_DYNAMIC_SECTIONS  = NO
 222 GENERATE_DOCSET        = NO
 223 DOCSET_FEEDNAME        = "Doxygen generated docs"
 224 DOCSET_BUNDLE_ID       = org.doxygen.Project
 225 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 226 DOCSET_PUBLISHER_NAME  = Publisher
 227 GENERATE_HTMLHELP      = NO
 228 CHM_FILE               =
 229 HHC_LOCATION           =
 230 GENERATE_CHI           = NO
 231 CHM_INDEX_ENCODING     =
 232 BINARY_TOC             = NO
 233 TOC_EXPAND             = YES
 234 GENERATE_QHP           = NO
 235 QCH_FILE               =
 236 QHP_NAMESPACE          = org.doxygen.Project
 237 QHP_VIRTUAL_FOLDER     = doc
 238 QHP_CUST_FILTER_NAME   =
 239 QHP_CUST_FILTER_ATTRS  =
 240 QHP_SECT_FILTER_ATTRS  =
 241 QHG_LOCATION           =
 242 GENERATE_ECLIPSEHELP   = NO
 243 ECLIPSE_DOC_ID         = org.doxygen.Project
 244 DISABLE_INDEX          = NO
 245 ENUM_VALUES_PER_LINE   = 4
 246 GENERATE_TREEVIEW      = YES
 247 USE_INLINE_TREES       = YES
 248 TREEVIEW_WIDTH         = 250
 249 EXT_LINKS_IN_WINDOW    = NO
 250 FORMULA_FONTSIZE       = 10
 251 FORMULA_TRANSPARENT    = YES
 252 USE_MATHJAX            = NO
 253 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 254 MATHJAX_EXTENSIONS     =
 255 SEARCHENGINE           = YES
 256 SERVER_BASED_SEARCH    = YES
 257 #---------------------------------------------------------------------------
 258 # configuration options related to the LaTeX output
 259 #---------------------------------------------------------------------------
 260 GENERATE_LATEX         = NO
 261 LATEX_OUTPUT           = latex
 262 LATEX_CMD_NAME         = latex
 263 MAKEINDEX_CMD_NAME     = makeindex
 264 COMPACT_LATEX          = NO
 265 PAPER_TYPE             = a4wide
 266 EXTRA_PACKAGES         =
 267 LATEX_HEADER           =
 268 LATEX_FOOTER           =
 269 PDF_HYPERLINKS         = YES
 270 USE_PDFLATEX           = YES
 271 LATEX_BATCHMODE        = NO
 272 LATEX_HIDE_INDICES     = NO
 273 LATEX_SOURCE_CODE      = NO
 274 LATEX_BIB_STYLE        = plain
 275 #---------------------------------------------------------------------------
 276 # configuration options related to the RTF output
 277 #---------------------------------------------------------------------------
 278 GENERATE_RTF           = NO
 279 RTF_OUTPUT             = rtf
 280 COMPACT_RTF            = NO
 281 RTF_HYPERLINKS         = NO
 282 RTF_STYLESHEET_FILE    =
 283 RTF_EXTENSIONS_FILE    =
 284 #---------------------------------------------------------------------------
 285 # configuration options related to the man page output
 286 #---------------------------------------------------------------------------
 287 GENERATE_MAN           = {{GENERATE_MAN}}
 288 MAN_OUTPUT             = man
 289 MAN_EXTENSION          = .3
 290 MAN_LINKS              = NO
 291 #---------------------------------------------------------------------------
 292 # configuration options related to the XML output
 293 #---------------------------------------------------------------------------
 294 GENERATE_XML           = NO
 295 XML_OUTPUT             = xml
 296 XML_SCHEMA             =
 297 XML_DTD                =
 298 XML_PROGRAMLISTING     = YES
 299 #---------------------------------------------------------------------------
 300 # configuration options for the AutoGen Definitions output
 301 #---------------------------------------------------------------------------
 302 GENERATE_AUTOGEN_DEF   = NO
 303 #---------------------------------------------------------------------------
 304 # configuration options related to the Perl module output
 305 #---------------------------------------------------------------------------
 306 GENERATE_PERLMOD       = NO
 307 PERLMOD_LATEX          = NO
 308 PERLMOD_PRETTY         = YES
 309 PERLMOD_MAKEVAR_PREFIX =
 310 #---------------------------------------------------------------------------
 311 # Configuration options related to the preprocessor
 312 #---------------------------------------------------------------------------
 313 ENABLE_PREPROCESSING   = YES
 314 MACRO_EXPANSION        = NO
 315 EXPAND_ONLY_PREDEF     = NO
 316 SEARCH_INCLUDES        = YES
 317 INCLUDE_PATH           =
 318 INCLUDE_FILE_PATTERNS  =
 319 PREDEFINED             =
 320 EXPAND_AS_DEFINED      =
 321 SKIP_FUNCTION_MACROS   = YES
 322 #---------------------------------------------------------------------------
 323 # Configuration::additions related to external references
 324 #---------------------------------------------------------------------------
 325 TAGFILES               =
 326 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
 327 ALLEXTERNALS           = NO
 328 EXTERNAL_GROUPS        = YES
 329 PERL_PATH              = /usr/bin/perl
 330 #---------------------------------------------------------------------------
 331 # Configuration options related to the dot tool
 332 #---------------------------------------------------------------------------
 333 CLASS_DIAGRAMS         = NO
 334 MSCGEN_PATH            =
 335 HIDE_UNDOC_RELATIONS   = YES
 336 HAVE_DOT               = {{HAVE_DOT}}
 337 DOT_NUM_THREADS        = 0
 338 DOT_FONTNAME           = Helvetica
 339 DOT_FONTSIZE           = 10
 340 DOT_FONTPATH           =
 341 CLASS_GRAPH            = YES
 342 COLLABORATION_GRAPH    = YES
 343 GROUP_GRAPHS           = YES
 344 UML_LOOK               = NO
 345 TEMPLATE_RELATIONS     = NO
 346 INCLUDE_GRAPH          = YES
 347 INCLUDED_BY_GRAPH      = YES
 348 CALL_GRAPH             = NO
 349 CALLER_GRAPH           = NO
 350 GRAPHICAL_HIERARCHY    = YES
 351 DIRECTORY_GRAPH        = YES
 352 DOT_IMAGE_FORMAT       = png
 353 INTERACTIVE_SVG        = NO
 354 DOT_PATH               =
 355 DOTFILE_DIRS           =
 356 MSCFILE_DIRS           =
 357 DOT_GRAPH_MAX_NODES    = 50
 358 MAX_DOT_GRAPH_DEPTH    = 1000
 359 DOT_TRANSPARENT        = NO
 360 DOT_MULTI_TARGETS      = NO
 361 GENERATE_LEGEND        = YES
 362 DOT_CLEANUP            = YES
 363