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