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          = *.php \
 148                          *.inc
 149 RECURSIVE              = YES
 150 EXCLUDE                = {{EXCLUDE}}
 151 EXCLUDE_SYMLINKS       = YES
 152 EXCLUDE_PATTERNS       = LocalSettings.php \
 153                          AdminSettings.php \
 154                          .svn \
 155                          */.git/* \
 156                          {{EXCLUDE_PATTERNS}}
 157 EXCLUDE_SYMBOLS        =
 158 EXAMPLE_PATH           =
 159 EXAMPLE_PATTERNS       = *
 160 EXAMPLE_RECURSIVE      = NO
 161 IMAGE_PATH             =
 162 INPUT_FILTER           = "{{INPUT_FILTER}}"
 163 FILTER_PATTERNS        =
 164 FILTER_SOURCE_FILES    = NO
 165 FILTER_SOURCE_PATTERNS =
 166 USE_MDFILE_AS_MAINPAGE =
 167 #---------------------------------------------------------------------------
 168 # Configuration options related to source browsing
 169 #---------------------------------------------------------------------------
 170 SOURCE_BROWSER         = YES
 171 INLINE_SOURCES         = NO
 172 STRIP_CODE_COMMENTS    = YES
 173 REFERENCED_BY_RELATION = YES
 174 REFERENCES_RELATION    = YES
 175 REFERENCES_LINK_SOURCE = YES
 176 SOURCE_TOOLTIPS        = YES
 177 USE_HTAGS              = NO
 178 VERBATIM_HEADERS       = YES
 179 #---------------------------------------------------------------------------
 180 # Configuration options related to the alphabetical class index
 181 #---------------------------------------------------------------------------
 182 ALPHABETICAL_INDEX     = NO
 183 COLS_IN_ALPHA_INDEX    = 5
 184 IGNORE_PREFIX          =
 185 #---------------------------------------------------------------------------
 186 # Configuration options related to the HTML output
 187 #---------------------------------------------------------------------------
 188 GENERATE_HTML          = YES
 189 HTML_OUTPUT            = html
 190 HTML_FILE_EXTENSION    = .html
 191 HTML_HEADER            =
 192 HTML_FOOTER            =
 193 HTML_STYLESHEET        =
 194 HTML_EXTRA_STYLESHEET  =
 195 HTML_EXTRA_FILES       =
 196 HTML_COLORSTYLE_HUE    = 220
 197 HTML_COLORSTYLE_SAT    = 100
 198 HTML_COLORSTYLE_GAMMA  = 80
 199 HTML_TIMESTAMP         = YES
 200 HTML_DYNAMIC_SECTIONS  = NO
 201 HTML_INDEX_NUM_ENTRIES = 100
 202 GENERATE_DOCSET        = NO
 203 DOCSET_FEEDNAME        = "Doxygen generated docs"
 204 DOCSET_BUNDLE_ID       = org.doxygen.Project
 205 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 206 DOCSET_PUBLISHER_NAME  = Publisher
 207 GENERATE_HTMLHELP      = NO
 208 CHM_FILE               =
 209 HHC_LOCATION           =
 210 GENERATE_CHI           = NO
 211 CHM_INDEX_ENCODING     =
 212 BINARY_TOC             = NO
 213 TOC_EXPAND             = YES
 214 GENERATE_QHP           = NO
 215 QCH_FILE               =
 216 QHP_NAMESPACE          = org.doxygen.Project
 217 QHP_VIRTUAL_FOLDER     = doc
 218 QHP_CUST_FILTER_NAME   =
 219 QHP_CUST_FILTER_ATTRS  =
 220 QHP_SECT_FILTER_ATTRS  =
 221 QHG_LOCATION           =
 222 GENERATE_ECLIPSEHELP   = NO
 223 ECLIPSE_DOC_ID         = org.doxygen.Project
 224 DISABLE_INDEX          = NO
 225 GENERATE_TREEVIEW      = YES
 226 ENUM_VALUES_PER_LINE   = 4
 227 TREEVIEW_WIDTH         = 250
 228 EXT_LINKS_IN_WINDOW    = NO
 229 FORMULA_FONTSIZE       = 10
 230 FORMULA_TRANSPARENT    = YES
 231 USE_MATHJAX            = NO
 232 MATHJAX_FORMAT         = HTML-CSS
 233 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 234 MATHJAX_EXTENSIONS     =
 235 MATHJAX_CODEFILE       =
 236 SEARCHENGINE           = YES
 237 SERVER_BASED_SEARCH    = YES
 238 EXTERNAL_SEARCH        = NO
 239 SEARCHENGINE_URL       =
 240 SEARCHDATA_FILE        = searchdata.xml
 241 EXTERNAL_SEARCH_ID     =
 242 EXTRA_SEARCH_MAPPINGS  =
 243 #---------------------------------------------------------------------------
 244 # Configuration options related to the LaTeX output
 245 #---------------------------------------------------------------------------
 246 GENERATE_LATEX         = NO
 247 LATEX_OUTPUT           = latex
 248 LATEX_CMD_NAME         = latex
 249 MAKEINDEX_CMD_NAME     = makeindex
 250 COMPACT_LATEX          = NO
 251 PAPER_TYPE             = a4wide
 252 EXTRA_PACKAGES         =
 253 LATEX_HEADER           =
 254 LATEX_FOOTER           =
 255 LATEX_EXTRA_FILES      =
 256 PDF_HYPERLINKS         = YES
 257 USE_PDFLATEX           = YES
 258 LATEX_BATCHMODE        = NO
 259 LATEX_HIDE_INDICES     = NO
 260 LATEX_SOURCE_CODE      = NO
 261 LATEX_BIB_STYLE        = plain
 262 #---------------------------------------------------------------------------
 263 # Configuration options related to the RTF output
 264 #---------------------------------------------------------------------------
 265 GENERATE_RTF           = NO
 266 RTF_OUTPUT             = rtf
 267 COMPACT_RTF            = NO
 268 RTF_HYPERLINKS         = NO
 269 RTF_STYLESHEET_FILE    =
 270 RTF_EXTENSIONS_FILE    =
 271 #---------------------------------------------------------------------------
 272 # Configuration options related to the man page output
 273 #---------------------------------------------------------------------------
 274 GENERATE_MAN           = {{GENERATE_MAN}}
 275 MAN_OUTPUT             = man
 276 MAN_EXTENSION          = .3
 277 MAN_LINKS              = NO
 278 #---------------------------------------------------------------------------
 279 # Configuration options related to the XML output
 280 #---------------------------------------------------------------------------
 281 GENERATE_XML           = NO
 282 XML_OUTPUT             = xml
 283 XML_PROGRAMLISTING     = YES
 284 #---------------------------------------------------------------------------
 285 # Configuration options related to the DOCBOOK output
 286 #---------------------------------------------------------------------------
 287 GENERATE_DOCBOOK       = NO
 288 DOCBOOK_OUTPUT         = docbook
 289 #---------------------------------------------------------------------------
 290 # Configuration options for the AutoGen Definitions output
 291 #---------------------------------------------------------------------------
 292 GENERATE_AUTOGEN_DEF   = NO
 293 #---------------------------------------------------------------------------
 294 # Configuration options related to the Perl module output
 295 #---------------------------------------------------------------------------
 296 GENERATE_PERLMOD       = NO
 297 PERLMOD_LATEX          = NO
 298 PERLMOD_PRETTY         = YES
 299 PERLMOD_MAKEVAR_PREFIX =
 300 #---------------------------------------------------------------------------
 301 # Configuration options related to the preprocessor
 302 #---------------------------------------------------------------------------
 303 ENABLE_PREPROCESSING   = YES
 304 MACRO_EXPANSION        = NO
 305 EXPAND_ONLY_PREDEF     = NO
 306 SEARCH_INCLUDES        = YES
 307 INCLUDE_PATH           =
 308 INCLUDE_FILE_PATTERNS  =
 309 PREDEFINED             =
 310 EXPAND_AS_DEFINED      =
 311 SKIP_FUNCTION_MACROS   = YES
 312 #---------------------------------------------------------------------------
 313 # Configuration options related to external references
 314 #---------------------------------------------------------------------------
 315 TAGFILES               =
 316 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
 317 ALLEXTERNALS           = NO
 318 EXTERNAL_GROUPS        = YES
 319 EXTERNAL_PAGES         = YES
 320 #---------------------------------------------------------------------------
 321 # Configuration options related to the dot tool
 322 #---------------------------------------------------------------------------
 323 CLASS_DIAGRAMS         = NO
 324 MSCGEN_PATH            =
 325 DIA_PATH               =
 326 HIDE_UNDOC_RELATIONS   = YES
 327 HAVE_DOT               = {{HAVE_DOT}}
 328 DOT_NUM_THREADS        = 0
 329 DOT_FONTNAME           = Helvetica
 330 DOT_FONTSIZE           = 10
 331 DOT_FONTPATH           =
 332 CLASS_GRAPH            = YES
 333 COLLABORATION_GRAPH    = YES
 334 GROUP_GRAPHS           = YES
 335 UML_LOOK               = NO
 336 UML_LIMIT_NUM_FIELDS   = 10
 337 TEMPLATE_RELATIONS     = NO
 338 INCLUDE_GRAPH          = YES
 339 INCLUDED_BY_GRAPH      = YES
 340 CALL_GRAPH             = NO
 341 CALLER_GRAPH           = NO
 342 GRAPHICAL_HIERARCHY    = YES
 343 DIRECTORY_GRAPH        = YES
 344 DOT_IMAGE_FORMAT       = png
 345 INTERACTIVE_SVG        = NO
 346 DOT_PATH               =
 347 DOTFILE_DIRS           =
 348 MSCFILE_DIRS           =
 349 DIAFILE_DIRS           =
 350 DOT_GRAPH_MAX_NODES    = 50
 351 MAX_DOT_GRAPH_DEPTH    = 1000
 352 DOT_TRANSPARENT        = NO
 353 DOT_MULTI_TARGETS      = YES
 354 GENERATE_LEGEND        = YES
 355 DOT_CLEANUP            = YES