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