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                          "access=\par Access:\n" \
  54                          "private=\access private" \
  55                          "protected=\access protected" \
  56                          "copyright=\note" \
  57                          "license=\note" \
  58                          "inheritDoc=\inheritdoc" \
  59                          "codeCoverageIgnore=" \
  60                          "codingStandardsIgnoreEnd=" \
  61                          "codingStandardsIgnoreStart=" \
  62                          "covers=" \
  63                          "dataProvider=" \
  64                          "expectedException=" \
  65                          "expectedExceptionMessage=" \
  66                          "group=" \
  67                          "phan=" \
  68                          "suppress="
  69 TCL_SUBST              =
  70 OPTIMIZE_OUTPUT_FOR_C  = NO
  71 OPTIMIZE_OUTPUT_JAVA   = NO
  72 OPTIMIZE_FOR_FORTRAN   = NO
  73 OPTIMIZE_OUTPUT_VHDL   = NO
  74 EXTENSION_MAPPING      =
  75 MARKDOWN_SUPPORT       = YES
  76 AUTOLINK_SUPPORT       = YES
  77 BUILTIN_STL_SUPPORT    = NO
  78 CPP_CLI_SUPPORT        = NO
  79 SIP_SUPPORT            = NO
  80 IDL_PROPERTY_SUPPORT   = YES
  81 DISTRIBUTE_GROUP_DOC   = YES
  82 SUBGROUPING            = YES
  83 INLINE_GROUPED_CLASSES = NO
  84 INLINE_SIMPLE_STRUCTS  = NO
  85 TYPEDEF_HIDES_STRUCT   = NO
  86 LOOKUP_CACHE_SIZE      = 2
  87 #---------------------------------------------------------------------------
  88 # Build related configuration options
  89 #---------------------------------------------------------------------------
  90 EXTRACT_ALL            = YES
  91 EXTRACT_PRIVATE        = YES
  92 EXTRACT_PACKAGE        = NO
  93 EXTRACT_STATIC         = YES
  94 EXTRACT_LOCAL_CLASSES  = YES
  95 EXTRACT_LOCAL_METHODS  = NO
  96 EXTRACT_ANON_NSPACES   = NO
  97 HIDE_UNDOC_MEMBERS     = NO
  98 HIDE_UNDOC_CLASSES     = NO
  99 HIDE_FRIEND_COMPOUNDS  = NO
 100 HIDE_IN_BODY_DOCS      = YES
 101 INTERNAL_DOCS          = NO
 102 CASE_SENSE_NAMES       = YES
 103 HIDE_SCOPE_NAMES       = NO
 104 SHOW_INCLUDE_FILES     = YES
 105 SHOW_GROUPED_MEMB_INC  = NO
 106 FORCE_LOCAL_INCLUDES   = NO
 107 INLINE_INFO            = YES
 108 SORT_MEMBER_DOCS       = YES
 109 SORT_BRIEF_DOCS        = YES
 110 SORT_MEMBERS_CTORS_1ST = NO
 111 SORT_GROUP_NAMES       = NO
 112 SORT_BY_SCOPE_NAME     = NO
 113 STRICT_PROTO_MATCHING  = NO
 114 GENERATE_TODOLIST      = YES
 115 GENERATE_TESTLIST      = YES
 116 GENERATE_BUGLIST       = YES
 117 GENERATE_DEPRECATEDLIST= YES
 118 ENABLED_SECTIONS       =
 119 MAX_INITIALIZER_LINES  = 30
 120 SHOW_USED_FILES        = YES
 121 SHOW_FILES             = YES
 122 SHOW_NAMESPACES        = NO
 123 FILE_VERSION_FILTER    =
 124 LAYOUT_FILE            =
 125 CITE_BIB_FILES         =
 126 #---------------------------------------------------------------------------
 127 # Configuration options related to warning and progress messages
 128 #---------------------------------------------------------------------------
 129 QUIET                  = YES
 130 WARNINGS               = YES
 131 WARN_IF_UNDOCUMENTED   = YES
 132 WARN_IF_DOC_ERROR      = YES
 133 WARN_NO_PARAMDOC       = NO
 134 WARN_FORMAT            = "$file:$line: $text"
 135 WARN_LOGFILE           =
 136 #---------------------------------------------------------------------------
 137 # Configuration options related to the input files
 138 #---------------------------------------------------------------------------
 139 INPUT                  = {{INPUT}}
 140 INPUT_ENCODING         = UTF-8
 141 FILE_PATTERNS          = *.php \
 142                          *.md \
 143                          *.inc
 144 RECURSIVE              = YES
 145 EXCLUDE                = {{EXCLUDE}}
 146 EXCLUDE_SYMLINKS       = YES
 147 EXCLUDE_PATTERNS       = LocalSettings.php \
 148                          AdminSettings.php \
 149                          .svn \
 150                          */.git/* \
 151                          {{EXCLUDE_PATTERNS}}
 152 EXCLUDE_SYMBOLS        =
 153 EXAMPLE_PATH           =
 154 EXAMPLE_PATTERNS       = *
 155 EXAMPLE_RECURSIVE      = NO
 156 IMAGE_PATH             =
 157 INPUT_FILTER           = "{{INPUT_FILTER}}"
 158 FILTER_PATTERNS        =
 159 FILTER_SOURCE_FILES    = NO
 160 FILTER_SOURCE_PATTERNS =
 161 USE_MDFILE_AS_MAINPAGE =
 162 #---------------------------------------------------------------------------
 163 # Configuration options related to source browsing
 164 #---------------------------------------------------------------------------
 165 SOURCE_BROWSER         = YES
 166 INLINE_SOURCES         = NO
 167 STRIP_CODE_COMMENTS    = YES
 168 REFERENCED_BY_RELATION = YES
 169 REFERENCES_RELATION    = YES
 170 REFERENCES_LINK_SOURCE = YES
 171 SOURCE_TOOLTIPS        = YES
 172 USE_HTAGS              = NO
 173 VERBATIM_HEADERS       = YES
 174 #---------------------------------------------------------------------------
 175 # Configuration options related to the alphabetical class index
 176 #---------------------------------------------------------------------------
 177 ALPHABETICAL_INDEX     = NO
 178 COLS_IN_ALPHA_INDEX    = 5
 179 IGNORE_PREFIX          =
 180 #---------------------------------------------------------------------------
 181 # Configuration options related to the HTML output
 182 #---------------------------------------------------------------------------
 183 GENERATE_HTML          = YES
 184 HTML_OUTPUT            = html
 185 HTML_FILE_EXTENSION    = .html
 186 HTML_HEADER            =
 187 HTML_FOOTER            =
 188 HTML_STYLESHEET        =
 189 HTML_EXTRA_STYLESHEET  =
 190 HTML_EXTRA_FILES       =
 191 HTML_COLORSTYLE_HUE    = 220
 192 HTML_COLORSTYLE_SAT    = 100
 193 HTML_COLORSTYLE_GAMMA  = 80
 194 HTML_TIMESTAMP         = YES
 195 HTML_DYNAMIC_SECTIONS  = NO
 196 HTML_INDEX_NUM_ENTRIES = 100
 197 GENERATE_DOCSET        = NO
 198 DOCSET_FEEDNAME        = "Doxygen generated docs"
 199 DOCSET_BUNDLE_ID       = org.doxygen.Project
 200 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 201 DOCSET_PUBLISHER_NAME  = Publisher
 202 GENERATE_HTMLHELP      = NO
 203 CHM_FILE               =
 204 HHC_LOCATION           =
 205 GENERATE_CHI           = NO
 206 CHM_INDEX_ENCODING     =
 207 BINARY_TOC             = NO
 208 TOC_EXPAND             = YES
 209 GENERATE_QHP           = NO
 210 QCH_FILE               =
 211 QHP_NAMESPACE          = org.doxygen.Project
 212 QHP_VIRTUAL_FOLDER     = doc
 213 QHP_CUST_FILTER_NAME   =
 214 QHP_CUST_FILTER_ATTRS  =
 215 QHP_SECT_FILTER_ATTRS  =
 216 QHG_LOCATION           =
 217 GENERATE_ECLIPSEHELP   = NO
 218 ECLIPSE_DOC_ID         = org.doxygen.Project
 219 DISABLE_INDEX          = NO
 220 GENERATE_TREEVIEW      = YES
 221 ENUM_VALUES_PER_LINE   = 4
 222 TREEVIEW_WIDTH         = 250
 223 EXT_LINKS_IN_WINDOW    = NO
 224 FORMULA_FONTSIZE       = 10
 225 FORMULA_TRANSPARENT    = YES
 226 USE_MATHJAX            = NO
 227 MATHJAX_FORMAT         = HTML-CSS
 228 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 229 MATHJAX_EXTENSIONS     =
 230 MATHJAX_CODEFILE       =
 231 SEARCHENGINE           = YES
 232 SERVER_BASED_SEARCH    = YES
 233 EXTERNAL_SEARCH        = NO
 234 SEARCHENGINE_URL       =
 235 SEARCHDATA_FILE        = searchdata.xml
 236 EXTERNAL_SEARCH_ID     =
 237 EXTRA_SEARCH_MAPPINGS  =
 238 #---------------------------------------------------------------------------
 239 # Configuration options related to the LaTeX output
 240 #---------------------------------------------------------------------------
 241 GENERATE_LATEX         = NO
 242 LATEX_OUTPUT           = latex
 243 LATEX_CMD_NAME         = latex
 244 MAKEINDEX_CMD_NAME     = makeindex
 245 COMPACT_LATEX          = NO
 246 PAPER_TYPE             = a4wide
 247 EXTRA_PACKAGES         =
 248 LATEX_HEADER           =
 249 LATEX_FOOTER           =
 250 LATEX_EXTRA_FILES      =
 251 PDF_HYPERLINKS         = YES
 252 USE_PDFLATEX           = YES
 253 LATEX_BATCHMODE        = NO
 254 LATEX_HIDE_INDICES     = NO
 255 LATEX_SOURCE_CODE      = NO
 256 LATEX_BIB_STYLE        = plain
 257 #---------------------------------------------------------------------------
 258 # Configuration options related to the RTF output
 259 #---------------------------------------------------------------------------
 260 GENERATE_RTF           = NO
 261 RTF_OUTPUT             = rtf
 262 COMPACT_RTF            = NO
 263 RTF_HYPERLINKS         = NO
 264 RTF_STYLESHEET_FILE    =
 265 RTF_EXTENSIONS_FILE    =
 266 #---------------------------------------------------------------------------
 267 # Configuration options related to the man page output
 268 #---------------------------------------------------------------------------
 269 GENERATE_MAN           = {{GENERATE_MAN}}
 270 MAN_OUTPUT             = man
 271 MAN_EXTENSION          = .3
 272 MAN_LINKS              = NO
 273 #---------------------------------------------------------------------------
 274 # Configuration options related to the XML output
 275 #---------------------------------------------------------------------------
 276 GENERATE_XML           = NO
 277 XML_OUTPUT             = xml
 278 XML_PROGRAMLISTING     = YES
 279 #---------------------------------------------------------------------------
 280 # Configuration options related to the DOCBOOK output
 281 #---------------------------------------------------------------------------
 282 GENERATE_DOCBOOK       = NO
 283 DOCBOOK_OUTPUT         = docbook
 284 #---------------------------------------------------------------------------
 285 # Configuration options for the AutoGen Definitions output
 286 #---------------------------------------------------------------------------
 287 GENERATE_AUTOGEN_DEF   = NO
 288 #---------------------------------------------------------------------------
 289 # Configuration options related to the Perl module output
 290 #---------------------------------------------------------------------------
 291 GENERATE_PERLMOD       = NO
 292 PERLMOD_LATEX          = NO
 293 PERLMOD_PRETTY         = YES
 294 PERLMOD_MAKEVAR_PREFIX =
 295 #---------------------------------------------------------------------------
 296 # Configuration options related to the preprocessor
 297 #---------------------------------------------------------------------------
 298 ENABLE_PREPROCESSING   = YES
 299 MACRO_EXPANSION        = NO
 300 EXPAND_ONLY_PREDEF     = NO
 301 SEARCH_INCLUDES        = YES
 302 INCLUDE_PATH           =
 303 INCLUDE_FILE_PATTERNS  =
 304 PREDEFINED             =
 305 EXPAND_AS_DEFINED      =
 306 SKIP_FUNCTION_MACROS   = YES
 307 #---------------------------------------------------------------------------
 308 # Configuration options related to external references
 309 #---------------------------------------------------------------------------
 310 TAGFILES               =
 311 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
 312 ALLEXTERNALS           = NO
 313 EXTERNAL_GROUPS        = YES
 314 EXTERNAL_PAGES         = YES
 315 #---------------------------------------------------------------------------
 316 # Configuration options related to the dot tool
 317 #---------------------------------------------------------------------------
 318 CLASS_DIAGRAMS         = NO
 319 MSCGEN_PATH            =
 320 DIA_PATH               =
 321 HIDE_UNDOC_RELATIONS   = YES
 322 HAVE_DOT               = {{HAVE_DOT}}
 323 DOT_NUM_THREADS        = 0
 324 DOT_FONTNAME           = Helvetica
 325 DOT_FONTSIZE           = 10
 326 DOT_FONTPATH           =
 327 CLASS_GRAPH            = YES
 328 COLLABORATION_GRAPH    = YES
 329 GROUP_GRAPHS           = YES
 330 UML_LOOK               = NO
 331 UML_LIMIT_NUM_FIELDS   = 10
 332 TEMPLATE_RELATIONS     = NO
 333 INCLUDE_GRAPH          = YES
 334 INCLUDED_BY_GRAPH      = YES
 335 CALL_GRAPH             = NO
 336 CALLER_GRAPH           = NO
 337 GRAPHICAL_HIERARCHY    = YES
 338 DIRECTORY_GRAPH        = YES
 339 DOT_IMAGE_FORMAT       = png
 340 INTERACTIVE_SVG        = NO
 341 DOT_PATH               =
 342 DOTFILE_DIRS           =
 343 MSCFILE_DIRS           =
 344 DIAFILE_DIRS           =
 345 DOT_GRAPH_MAX_NODES    = 50
 346 MAX_DOT_GRAPH_DEPTH    = 1000
 347 DOT_TRANSPARENT        = NO
 348 DOT_MULTI_TARGETS      = YES
 349 GENERATE_LEGEND        = YES
 350 DOT_CLEANUP            = YES