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