maintenance/Doxyfile

   1 # Doxyfile 1.7.6.1
   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}}
   8 # {{CURRENT_VERSION}}
   9 # {{STRIP_FROM_PATH}}
  10 # {{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 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 BUILTIN_STL_SUPPORT    = NO
  76 CPP_CLI_SUPPORT        = NO
  77 SIP_SUPPORT            = NO
  78 IDL_PROPERTY_SUPPORT   = YES
  79 DISTRIBUTE_GROUP_DOC   = YES
  80 SUBGROUPING            = YES
  81 INLINE_GROUPED_CLASSES = NO
  82 INLINE_SIMPLE_STRUCTS  = NO
  83 TYPEDEF_HIDES_STRUCT   = NO
  84 SYMBOL_CACHE_SIZE      = 0
  85 LOOKUP_CACHE_SIZE      = 1
  86 #---------------------------------------------------------------------------
  87 # Build related configuration options
  88 #---------------------------------------------------------------------------
  89 EXTRACT_ALL            = YES
  90 EXTRACT_PRIVATE        = YES
  91 EXTRACT_STATIC         = YES
  92 EXTRACT_LOCAL_CLASSES  = YES
  93 EXTRACT_LOCAL_METHODS  = NO
  94 EXTRACT_ANON_NSPACES   = NO
  95 HIDE_UNDOC_MEMBERS     = NO
  96 HIDE_UNDOC_CLASSES     = NO
  97 HIDE_FRIEND_COMPOUNDS  = NO
  98 HIDE_IN_BODY_DOCS      = YES
  99 INTERNAL_DOCS          = NO
 100 CASE_SENSE_NAMES       = YES
 101 HIDE_SCOPE_NAMES       = NO
 102 SHOW_INCLUDE_FILES     = YES
 103 FORCE_LOCAL_INCLUDES   = NO
 104 INLINE_INFO            = YES
 105 SORT_MEMBER_DOCS       = YES
 106 SORT_BRIEF_DOCS        = YES
 107 SORT_MEMBERS_CTORS_1ST = NO
 108 SORT_GROUP_NAMES       = NO
 109 SORT_BY_SCOPE_NAME     = NO
 110 STRICT_PROTO_MATCHING  = NO
 111 GENERATE_TODOLIST      = YES
 112 GENERATE_TESTLIST      = YES
 113 GENERATE_BUGLIST       = YES
 114 GENERATE_DEPRECATEDLIST= YES
 115 ENABLED_SECTIONS       =
 116 MAX_INITIALIZER_LINES  = 30
 117 SHOW_USED_FILES        = YES
 118 SHOW_DIRECTORIES       = YES
 119 SHOW_FILES             = YES
 120 SHOW_NAMESPACES        = NO
 121 FILE_VERSION_FILTER    =
 122 LAYOUT_FILE            =
 123 CITE_BIB_FILES         =
 124 #---------------------------------------------------------------------------
 125 # configuration options related to warning and progress messages
 126 #---------------------------------------------------------------------------
 127 QUIET                  = NO
 128 WARNINGS               = YES
 129 WARN_IF_UNDOCUMENTED   = YES
 130 WARN_IF_DOC_ERROR      = YES
 131 WARN_NO_PARAMDOC       = NO
 132 WARN_FORMAT            = "$file:$line: $text"
 133 WARN_LOGFILE           =
 134 #---------------------------------------------------------------------------
 135 # configuration options related to the input files
 136 #---------------------------------------------------------------------------
 137 INPUT                  = {{INPUT}}
 138 INPUT_ENCODING         = UTF-8
 139 FILE_PATTERNS          = *.c \
 140                          *.cc \
 141                          *.cxx \
 142                          *.cpp \
 143                          *.c++ \
 144                          *.d \
 145                          *.java \
 146                          *.ii \
 147                          *.ixx \
 148                          *.ipp \
 149                          *.i++ \
 150                          *.inl \
 151                          *.h \
 152                          *.hh \
 153                          *.hxx \
 154                          *.hpp \
 155                          *.h++ \
 156                          *.idl \
 157                          *.odl \
 158                          *.cs \
 159                          *.php \
 160                          *.php5 \
 161                          *.inc \
 162                          *.m \
 163                          *.mm \
 164                          *.dox \
 165                          *.py \
 166                          *.C \
 167                          *.CC \
 168                          *.C++ \
 169                          *.II \
 170                          *.I++ \
 171                          *.H \
 172                          *.HH \
 173                          *.H++ \
 174                          *.CS \
 175                          *.PHP \
 176                          *.PHP5 \
 177                          *.M \
 178                          *.MM \
 179                          *.PY \
 180                          *.txt \
 181                          README
 182 RECURSIVE              = YES
 183 EXCLUDE                = {{EXCLUDE}}
 184 EXCLUDE_SYMLINKS       = YES
 185 EXCLUDE_PATTERNS       = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
 186 EXCLUDE_SYMBOLS        =
 187 EXAMPLE_PATH           =
 188 EXAMPLE_PATTERNS       = *
 189 EXAMPLE_RECURSIVE      = NO
 190 IMAGE_PATH             =
 191 INPUT_FILTER           = "{{INPUT_FILTER}}"
 192 FILTER_PATTERNS        =
 193 FILTER_SOURCE_FILES    = NO
 194 FILTER_SOURCE_PATTERNS =
 195 #---------------------------------------------------------------------------
 196 # configuration options related to source browsing
 197 #---------------------------------------------------------------------------
 198 SOURCE_BROWSER         = YES
 199 INLINE_SOURCES         = NO
 200 STRIP_CODE_COMMENTS    = YES
 201 REFERENCED_BY_RELATION = YES
 202 REFERENCES_RELATION    = YES
 203 REFERENCES_LINK_SOURCE = YES
 204 USE_HTAGS              = NO
 205 VERBATIM_HEADERS       = YES
 206 #---------------------------------------------------------------------------
 207 # configuration options related to the alphabetical class index
 208 #---------------------------------------------------------------------------
 209 ALPHABETICAL_INDEX     = NO
 210 COLS_IN_ALPHA_INDEX    = 5
 211 IGNORE_PREFIX          =
 212 #---------------------------------------------------------------------------
 213 # configuration options related to the HTML output
 214 #---------------------------------------------------------------------------
 215 GENERATE_HTML          = YES
 216 HTML_OUTPUT            = html
 217 HTML_FILE_EXTENSION    = .html
 218 HTML_HEADER            =
 219 HTML_FOOTER            =
 220 HTML_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_ALIGN_MEMBERS     = YES
 227 HTML_DYNAMIC_SECTIONS  = NO
 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 ENUM_VALUES_PER_LINE   = 4
 252 GENERATE_TREEVIEW      = YES
 253 USE_INLINE_TREES       = YES
 254 TREEVIEW_WIDTH         = 250
 255 EXT_LINKS_IN_WINDOW    = NO
 256 FORMULA_FONTSIZE       = 10
 257 FORMULA_TRANSPARENT    = YES
 258 USE_MATHJAX            = NO
 259 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 260 MATHJAX_EXTENSIONS     =
 261 SEARCHENGINE           = YES
 262 SERVER_BASED_SEARCH    = YES
 263 #---------------------------------------------------------------------------
 264 # configuration options related to the LaTeX output
 265 #---------------------------------------------------------------------------
 266 GENERATE_LATEX         = NO
 267 LATEX_OUTPUT           = latex
 268 LATEX_CMD_NAME         = latex
 269 MAKEINDEX_CMD_NAME     = makeindex
 270 COMPACT_LATEX          = NO
 271 PAPER_TYPE             = a4wide
 272 EXTRA_PACKAGES         =
 273 LATEX_HEADER           =
 274 LATEX_FOOTER           =
 275 PDF_HYPERLINKS         = YES
 276 USE_PDFLATEX           = YES
 277 LATEX_BATCHMODE        = NO
 278 LATEX_HIDE_INDICES     = NO
 279 LATEX_SOURCE_CODE      = NO
 280 LATEX_BIB_STYLE        = plain
 281 #---------------------------------------------------------------------------
 282 # configuration options related to the RTF output
 283 #---------------------------------------------------------------------------
 284 GENERATE_RTF           = NO
 285 RTF_OUTPUT             = rtf
 286 COMPACT_RTF            = NO
 287 RTF_HYPERLINKS         = NO
 288 RTF_STYLESHEET_FILE    =
 289 RTF_EXTENSIONS_FILE    =
 290 #---------------------------------------------------------------------------
 291 # configuration options related to the man page output
 292 #---------------------------------------------------------------------------
 293 GENERATE_MAN           = {{GENERATE_MAN}}
 294 MAN_OUTPUT             = man
 295 MAN_EXTENSION          = .3
 296 MAN_LINKS              = NO
 297 #---------------------------------------------------------------------------
 298 # configuration options related to the XML output
 299 #---------------------------------------------------------------------------
 300 GENERATE_XML           = NO
 301 XML_OUTPUT             = xml
 302 XML_SCHEMA             =
 303 XML_DTD                =
 304 XML_PROGRAMLISTING     = YES
 305 #---------------------------------------------------------------------------
 306 # configuration options for the AutoGen Definitions output
 307 #---------------------------------------------------------------------------
 308 GENERATE_AUTOGEN_DEF   = NO
 309 #---------------------------------------------------------------------------
 310 # configuration options related to the Perl module output
 311 #---------------------------------------------------------------------------
 312 GENERATE_PERLMOD       = NO
 313 PERLMOD_LATEX          = NO
 314 PERLMOD_PRETTY         = YES
 315 PERLMOD_MAKEVAR_PREFIX =
 316 #---------------------------------------------------------------------------
 317 # Configuration options related to the preprocessor
 318 #---------------------------------------------------------------------------
 319 ENABLE_PREPROCESSING   = YES
 320 MACRO_EXPANSION        = NO
 321 EXPAND_ONLY_PREDEF     = NO
 322 SEARCH_INCLUDES        = YES
 323 INCLUDE_PATH           =
 324 INCLUDE_FILE_PATTERNS  =
 325 PREDEFINED             =
 326 EXPAND_AS_DEFINED      =
 327 SKIP_FUNCTION_MACROS   = YES
 328 #---------------------------------------------------------------------------
 329 # Configuration::additions related to external references
 330 #---------------------------------------------------------------------------
 331 TAGFILES               =
 332 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
 333 ALLEXTERNALS           = NO
 334 EXTERNAL_GROUPS        = YES
 335 PERL_PATH              = /usr/bin/perl
 336 #---------------------------------------------------------------------------
 337 # Configuration options related to the dot tool
 338 #---------------------------------------------------------------------------
 339 CLASS_DIAGRAMS         = NO
 340 MSCGEN_PATH            =
 341 HIDE_UNDOC_RELATIONS   = YES
 342 HAVE_DOT               = {{HAVE_DOT}}
 343 DOT_NUM_THREADS        = 0
 344 DOT_FONTNAME           = Helvetica
 345 DOT_FONTSIZE           = 10
 346 DOT_FONTPATH           =
 347 CLASS_GRAPH            = YES
 348 COLLABORATION_GRAPH    = YES
 349 GROUP_GRAPHS           = YES
 350 UML_LOOK               = NO
 351 TEMPLATE_RELATIONS     = NO
 352 INCLUDE_GRAPH          = YES
 353 INCLUDED_BY_GRAPH      = YES
 354 CALL_GRAPH             = NO
 355 CALLER_GRAPH           = NO
 356 GRAPHICAL_HIERARCHY    = YES
 357 DIRECTORY_GRAPH        = YES
 358 DOT_IMAGE_FORMAT       = png
 359 INTERACTIVE_SVG        = NO
 360 DOT_PATH               =
 361 DOTFILE_DIRS           =
 362 MSCFILE_DIRS           =
 363 DOT_GRAPH_MAX_NODES    = 50
 364 MAX_DOT_GRAPH_DEPTH    = 1000
 365 DOT_TRANSPARENT        = NO
 366 DOT_MULTI_TARGETS      = YES
 367 GENERATE_LEGEND        = YES
 368 DOT_CLEANUP            = YES
 369