maintenance/Doxyfile

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