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