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