maintenance/Doxyfile

   1 # Doxyfile 1.5.6
   2
   3 #
   4 # Some placeholders have been added for MediaWiki usage:
   5 # {{OUTPUT_DIRECTORY}}
   6 # {{CURRENT_VERSION}}
   7 # {{STRIP_FROM_PATH}}
   8 # {{SVNSTAT}}
   9 # {{INPUT}}
  10 #
  11 # A number of MediaWiki-specific aliases are near the end of this file.
  12 # To generate documentation run: php mwdocgen.php --no-extensions
  13
  14 #---------------------------------------------------------------------------
  15 # Project related configuration options
  16 #---------------------------------------------------------------------------
  17 PROJECT_NAME           = MediaWiki
  18 PROJECT_NUMBER         = {{CURRENT_VERSION}}
  19 OUTPUT_DIRECTORY       = {{OUTPUT_DIRECTORY}}
  20 CREATE_SUBDIRS         = NO
  21 OUTPUT_LANGUAGE        = English
  22 BRIEF_MEMBER_DESC      = YES
  23 REPEAT_BRIEF           = YES
  24 ABBREVIATE_BRIEF       = "The $name class" \
  25                          "The $name widget" \
  26                          "The $name file" \
  27                          is \
  28                          provides \
  29                          specifies \
  30                          contains \
  31                          represents \
  32                          a \
  33                          an \
  34                          the
  35 ALWAYS_DETAILED_SEC    = NO
  36 INLINE_INHERITED_MEMB  = NO
  37 FULL_PATH_NAMES        = YES
  38 STRIP_FROM_PATH        = {{STRIP_FROM_PATH}}
  39 STRIP_FROM_INC_PATH    =
  40 SHORT_NAMES            = NO
  41 JAVADOC_AUTOBRIEF      = YES
  42 MULTILINE_CPP_IS_BRIEF = NO
  43 INHERIT_DOCS           = YES
  44 SEPARATE_MEMBER_PAGES  = NO
  45 TAB_SIZE               = 8
  46 OPTIMIZE_OUTPUT_FOR_C  = NO
  47 OPTIMIZE_OUTPUT_JAVA   = NO
  48 BUILTIN_STL_SUPPORT    = NO
  49 DISTRIBUTE_GROUP_DOC   = YES
  50 SUBGROUPING            = YES
  51 #---------------------------------------------------------------------------
  52 # Build related configuration options
  53 #---------------------------------------------------------------------------
  54 EXTRACT_ALL            = YES
  55 EXTRACT_PRIVATE        = YES
  56 EXTRACT_STATIC         = YES
  57 EXTRACT_LOCAL_CLASSES  = YES
  58 EXTRACT_LOCAL_METHODS  = NO
  59 HIDE_UNDOC_MEMBERS     = NO
  60 HIDE_UNDOC_CLASSES     = NO
  61 HIDE_FRIEND_COMPOUNDS  = NO
  62 HIDE_IN_BODY_DOCS      = YES
  63 INTERNAL_DOCS          = NO
  64 CASE_SENSE_NAMES       = YES
  65 HIDE_SCOPE_NAMES       = NO
  66 SHOW_INCLUDE_FILES     = YES
  67 INLINE_INFO            = YES
  68 SORT_MEMBER_DOCS       = YES
  69 SORT_BRIEF_DOCS        = NO
  70 SORT_BY_SCOPE_NAME     = NO
  71 GENERATE_TODOLIST      = YES
  72 GENERATE_TESTLIST      = YES
  73 GENERATE_BUGLIST       = YES
  74 GENERATE_DEPRECATEDLIST= YES
  75 ENABLED_SECTIONS       =
  76 MAX_INITIALIZER_LINES  = 30
  77 SHOW_USED_FILES        = YES
  78 SHOW_DIRECTORIES       = NO
  79 SHOW_NAMESPACES        = NO
  80 FILE_VERSION_FILTER    = {{SVNSTAT}}
  81 #---------------------------------------------------------------------------
  82 # configuration options related to warning and progress messages
  83 #---------------------------------------------------------------------------
  84 QUIET                  = NO
  85 WARNINGS               = YES
  86 WARN_IF_UNDOCUMENTED   = YES
  87 WARN_IF_DOC_ERROR      = YES
  88 WARN_NO_PARAMDOC       = NO
  89 WARN_FORMAT            = "$file:$line: $text"
  90 WARN_LOGFILE           =
  91 #---------------------------------------------------------------------------
  92 # configuration options related to the input files
  93 #---------------------------------------------------------------------------
  94 INPUT                  = {{INPUT}}
  95 FILE_PATTERNS          = *.c \
  96                          *.cc \
  97                          *.cxx \
  98                          *.cpp \
  99                          *.c++ \
 100                          *.d \
 101                          *.java \
 102                          *.ii \
 103                          *.ixx \
 104                          *.ipp \
 105                          *.i++ \
 106                          *.inl \
 107                          *.h \
 108                          *.hh \
 109                          *.hxx \
 110                          *.hpp \
 111                          *.h++ \
 112                          *.idl \
 113                          *.odl \
 114                          *.cs \
 115                          *.php \
 116                          *.php3 \
 117                          *.inc \
 118                          *.m \
 119                          *.mm \
 120                          *.dox \
 121                          *.py \
 122                          *.C \
 123                          *.CC \
 124                          *.C++ \
 125                          *.II \
 126                          *.I++ \
 127                          *.H \
 128                          *.HH \
 129                          *.H++ \
 130                          *.CS \
 131                          *.PHP \
 132                          *.PHP3 \
 133                          *.M \
 134                          *.MM \
 135                          *.PY
 136 RECURSIVE              = YES
 137 EXCLUDE                =
 138 EXCLUDE_SYMLINKS       = YES
 139 EXCLUDE_PATTERNS       = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE}}
 140 EXAMPLE_PATH           =
 141 EXAMPLE_PATTERNS       = *
 142 EXAMPLE_RECURSIVE      = NO
 143 IMAGE_PATH             =
 144 INPUT_FILTER           =
 145 FILTER_PATTERNS        =
 146 FILTER_SOURCE_FILES    = NO
 147 #---------------------------------------------------------------------------
 148 # configuration options related to source browsing
 149 #---------------------------------------------------------------------------
 150 SOURCE_BROWSER         = YES
 151 INLINE_SOURCES         = NO
 152 STRIP_CODE_COMMENTS    = YES
 153 REFERENCED_BY_RELATION = YES
 154 REFERENCES_RELATION    = YES
 155 USE_HTAGS              = NO
 156 VERBATIM_HEADERS       = YES
 157 #---------------------------------------------------------------------------
 158 # configuration options related to the alphabetical class index
 159 #---------------------------------------------------------------------------
 160 ALPHABETICAL_INDEX     = NO
 161 COLS_IN_ALPHA_INDEX    = 5
 162 IGNORE_PREFIX          =
 163 #---------------------------------------------------------------------------
 164 # configuration options related to the HTML output
 165 #---------------------------------------------------------------------------
 166 GENERATE_HTML          = YES
 167 HTML_OUTPUT            = html
 168 HTML_FILE_EXTENSION    = .html
 169 HTML_HEADER            =
 170 HTML_FOOTER            =
 171 HTML_STYLESHEET        =
 172 HTML_ALIGN_MEMBERS     = YES
 173 GENERATE_HTMLHELP      = NO
 174 CHM_FILE               =
 175 HHC_LOCATION           =
 176 GENERATE_CHI           = NO
 177 BINARY_TOC             = NO
 178 TOC_EXPAND             = YES
 179 DISABLE_INDEX          = NO
 180 ENUM_VALUES_PER_LINE   = 4
 181 GENERATE_TREEVIEW      = YES
 182 TREEVIEW_WIDTH         = 250
 183 #---------------------------------------------------------------------------
 184 # configuration options related to the LaTeX output
 185 #---------------------------------------------------------------------------
 186 GENERATE_LATEX         = NO
 187 LATEX_OUTPUT           = latex
 188 LATEX_CMD_NAME         = latex
 189 MAKEINDEX_CMD_NAME     = makeindex
 190 COMPACT_LATEX          = NO
 191 PAPER_TYPE             = a4wide
 192 EXTRA_PACKAGES         =
 193 LATEX_HEADER           =
 194 PDF_HYPERLINKS         = YES
 195 USE_PDFLATEX           = YES
 196 LATEX_BATCHMODE        = NO
 197 LATEX_HIDE_INDICES     = NO
 198 #---------------------------------------------------------------------------
 199 # configuration options related to the RTF output
 200 #---------------------------------------------------------------------------
 201 GENERATE_RTF           = NO
 202 RTF_OUTPUT             = rtf
 203 COMPACT_RTF            = NO
 204 RTF_HYPERLINKS         = NO
 205 RTF_STYLESHEET_FILE    =
 206 RTF_EXTENSIONS_FILE    =
 207 #---------------------------------------------------------------------------
 208 # configuration options related to the man page output
 209 #---------------------------------------------------------------------------
 210 GENERATE_MAN           = NO
 211 MAN_OUTPUT             = man
 212 MAN_EXTENSION          = .3
 213 MAN_LINKS              = NO
 214 #---------------------------------------------------------------------------
 215 # configuration options related to the XML output
 216 #---------------------------------------------------------------------------
 217 GENERATE_XML           = NO
 218 XML_OUTPUT             = xml
 219 XML_SCHEMA             =
 220 XML_DTD                =
 221 XML_PROGRAMLISTING     = YES
 222 #---------------------------------------------------------------------------
 223 # configuration options for the AutoGen Definitions output
 224 #---------------------------------------------------------------------------
 225 GENERATE_AUTOGEN_DEF   = NO
 226 #---------------------------------------------------------------------------
 227 # configuration options related to the Perl module output
 228 #---------------------------------------------------------------------------
 229 GENERATE_PERLMOD       = NO
 230 PERLMOD_LATEX          = NO
 231 PERLMOD_PRETTY         = YES
 232 PERLMOD_MAKEVAR_PREFIX =
 233 #---------------------------------------------------------------------------
 234 # Configuration options related to the preprocessor
 235 #---------------------------------------------------------------------------
 236 ENABLE_PREPROCESSING   = YES
 237 MACRO_EXPANSION        = NO
 238 EXPAND_ONLY_PREDEF     = NO
 239 SEARCH_INCLUDES        = YES
 240 INCLUDE_PATH           =
 241 INCLUDE_FILE_PATTERNS  =
 242 PREDEFINED             =
 243 EXPAND_AS_DEFINED      =
 244 SKIP_FUNCTION_MACROS   = YES
 245 #---------------------------------------------------------------------------
 246 # Configuration::additions related to external references
 247 #---------------------------------------------------------------------------
 248 TAGFILES               =
 249 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
 250 ALLEXTERNALS           = NO
 251 EXTERNAL_GROUPS        = YES
 252 PERL_PATH              = /usr/bin/perl
 253 #---------------------------------------------------------------------------
 254 # Configuration options related to the dot tool
 255 #---------------------------------------------------------------------------
 256 CLASS_DIAGRAMS         = NO
 257 HIDE_UNDOC_RELATIONS   = YES
 258 HAVE_DOT               = NO
 259 CLASS_GRAPH            = YES
 260 COLLABORATION_GRAPH    = YES
 261 GROUP_GRAPHS           = YES
 262 UML_LOOK               = NO
 263 TEMPLATE_RELATIONS     = NO
 264 INCLUDE_GRAPH          = YES
 265 INCLUDED_BY_GRAPH      = YES
 266 CALL_GRAPH             = YES
 267 GRAPHICAL_HIERARCHY    = YES
 268 DIRECTORY_GRAPH        = YES
 269 DOT_IMAGE_FORMAT       = png
 270 DOT_PATH               =
 271 DOTFILE_DIRS           =
 272 MAX_DOT_GRAPH_DEPTH    = 1000
 273 DOT_TRANSPARENT        = NO
 274 DOT_MULTI_TARGETS      = NO
 275 GENERATE_LEGEND        = YES
 276 DOT_CLEANUP            = YES
 277 #---------------------------------------------------------------------------
 278 # Configuration::additions related to the search engine
 279 #---------------------------------------------------------------------------
 280 SEARCHENGINE           = NO
 281
 282 ALIASES =       "type{1}=<b> \1 </b>:" \
 283                 "types{2}=<b> \1 </b> or <b> \2 </b>:" \
 284                 "types{3}=<b> \1 </b>, <b> \2 </b>, or <b> \3 </b>:" \
 285                 "arrayof{2}=<b> Array </b> of \2" \
 286                 "null=\type{Null}" \
 287                 "boolean=\type{Boolean}" \
 288                 "bool=\type{Boolean}" \
 289                 "integer=\type{Integer}" \
 290                 "int=\type{Integer}" \
 291                 "string=\type{String}" \
 292                 "str=\type{String}" \
 293                 "mixed=\type{Mixed}" \
 294                 "access=\par Access:\n" \
 295                 "private=\access private" \
 296                 "protected=\access protected" \
 297                 "public=\access public" \
 298                 "copyright=\note" \
 299                 "license=\note"
 300