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                          "codingStandardsIgnoreEnd=" \
  61                          "codingStandardsIgnoreStart=" \
  62                          "phan=" \
  63                          "suppress="
  64 TCL_SUBST              =
  65 OPTIMIZE_OUTPUT_FOR_C  = NO
  66 OPTIMIZE_OUTPUT_JAVA   = NO
  67 OPTIMIZE_FOR_FORTRAN   = NO
  68 OPTIMIZE_OUTPUT_VHDL   = NO
  69 EXTENSION_MAPPING      =
  70 MARKDOWN_SUPPORT       = YES
  71 AUTOLINK_SUPPORT       = YES
  72 BUILTIN_STL_SUPPORT    = NO
  73 CPP_CLI_SUPPORT        = NO
  74 SIP_SUPPORT            = NO
  75 IDL_PROPERTY_SUPPORT   = YES
  76 DISTRIBUTE_GROUP_DOC   = YES
  77 SUBGROUPING            = YES
  78 INLINE_GROUPED_CLASSES = NO
  79 INLINE_SIMPLE_STRUCTS  = NO
  80 TYPEDEF_HIDES_STRUCT   = NO
  81 LOOKUP_CACHE_SIZE      = 2
  82 #---------------------------------------------------------------------------
  83 # Build related configuration options
  84 #---------------------------------------------------------------------------
  85 EXTRACT_ALL            = YES
  86 EXTRACT_PRIVATE        = YES
  87 EXTRACT_PACKAGE        = NO
  88 EXTRACT_STATIC         = YES
  89 EXTRACT_LOCAL_CLASSES  = YES
  90 EXTRACT_LOCAL_METHODS  = NO
  91 EXTRACT_ANON_NSPACES   = NO
  92 HIDE_UNDOC_MEMBERS     = NO
  93 HIDE_UNDOC_CLASSES     = NO
  94 HIDE_FRIEND_COMPOUNDS  = NO
  95 HIDE_IN_BODY_DOCS      = YES
  96 INTERNAL_DOCS          = NO
  97 CASE_SENSE_NAMES       = YES
  98 HIDE_SCOPE_NAMES       = NO
  99 SHOW_INCLUDE_FILES     = YES
 100 SHOW_GROUPED_MEMB_INC  = NO
 101 FORCE_LOCAL_INCLUDES   = NO
 102 INLINE_INFO            = YES
 103 SORT_MEMBER_DOCS       = YES
 104 SORT_BRIEF_DOCS        = YES
 105 SORT_MEMBERS_CTORS_1ST = NO
 106 SORT_GROUP_NAMES       = NO
 107 SORT_BY_SCOPE_NAME     = NO
 108 STRICT_PROTO_MATCHING  = NO
 109 GENERATE_TODOLIST      = YES
 110 GENERATE_TESTLIST      = NO
 111 GENERATE_BUGLIST       = NO
 112 GENERATE_DEPRECATEDLIST= YES
 113 ENABLED_SECTIONS       =
 114 MAX_INITIALIZER_LINES  = 30
 115 SHOW_USED_FILES        = YES
 116 SHOW_FILES             = YES
 117 SHOW_NAMESPACES        = NO
 118 FILE_VERSION_FILTER    =
 119 LAYOUT_FILE            =
 120 CITE_BIB_FILES         =
 121 #---------------------------------------------------------------------------
 122 # Configuration options related to warning and progress messages
 123 #---------------------------------------------------------------------------
 124 QUIET                  = YES
 125 WARNINGS               = YES
 126 WARN_IF_UNDOCUMENTED   = YES
 127 WARN_IF_DOC_ERROR      = YES
 128 WARN_NO_PARAMDOC       = NO
 129 WARN_FORMAT            = "$file:$line: $text"
 130 WARN_LOGFILE           =
 131 #---------------------------------------------------------------------------
 132 # Configuration options related to the input files
 133 #---------------------------------------------------------------------------
 134 INPUT                  = {{INPUT}}
 135 INPUT_ENCODING         = UTF-8
 136 FILE_PATTERNS          = *.php \
 137                          *.md \
 138                          *.inc
 139 RECURSIVE              = YES
 140 EXCLUDE                = {{EXCLUDE}}
 141 EXCLUDE_SYMLINKS       = YES
 142 EXCLUDE_PATTERNS       = LocalSettings.php \
 143                          AdminSettings.php \
 144                          .svn \
 145                          */.git/* \
 146                          {{EXCLUDE_PATTERNS}}
 147 EXCLUDE_SYMBOLS        =
 148 EXAMPLE_PATH           =
 149 EXAMPLE_PATTERNS       = *
 150 EXAMPLE_RECURSIVE      = NO
 151 IMAGE_PATH             =
 152 INPUT_FILTER           = "{{INPUT_FILTER}}"
 153 FILTER_PATTERNS        =
 154 FILTER_SOURCE_FILES    = NO
 155 FILTER_SOURCE_PATTERNS =
 156 USE_MDFILE_AS_MAINPAGE =
 157 #---------------------------------------------------------------------------
 158 # Configuration options related to source browsing
 159 #---------------------------------------------------------------------------
 160 SOURCE_BROWSER         = YES
 161 INLINE_SOURCES         = NO
 162 STRIP_CODE_COMMENTS    = YES
 163 REFERENCED_BY_RELATION = YES
 164 REFERENCES_RELATION    = YES
 165 REFERENCES_LINK_SOURCE = YES
 166 SOURCE_TOOLTIPS        = YES
 167 USE_HTAGS              = NO
 168 VERBATIM_HEADERS       = YES
 169 #---------------------------------------------------------------------------
 170 # Configuration options related to the alphabetical class index
 171 #---------------------------------------------------------------------------
 172 ALPHABETICAL_INDEX     = NO
 173 COLS_IN_ALPHA_INDEX    = 5
 174 IGNORE_PREFIX          =
 175 #---------------------------------------------------------------------------
 176 # Configuration options related to the HTML output
 177 #---------------------------------------------------------------------------
 178 GENERATE_HTML          = YES
 179 HTML_OUTPUT            = html
 180 HTML_FILE_EXTENSION    = .html
 181 HTML_HEADER            =
 182 HTML_FOOTER            =
 183 HTML_STYLESHEET        =
 184 HTML_EXTRA_STYLESHEET  =
 185 HTML_EXTRA_FILES       =
 186 HTML_COLORSTYLE_HUE    = 220
 187 HTML_COLORSTYLE_SAT    = 100
 188 HTML_COLORSTYLE_GAMMA  = 80
 189 HTML_TIMESTAMP         = YES
 190 HTML_DYNAMIC_SECTIONS  = NO
 191 HTML_INDEX_NUM_ENTRIES = 100
 192 GENERATE_DOCSET        = NO
 193 DOCSET_FEEDNAME        = "Doxygen generated docs"
 194 DOCSET_BUNDLE_ID       = org.doxygen.Project
 195 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 196 DOCSET_PUBLISHER_NAME  = Publisher
 197 GENERATE_HTMLHELP      = NO
 198 CHM_FILE               =
 199 HHC_LOCATION           =
 200 GENERATE_CHI           = NO
 201 CHM_INDEX_ENCODING     =
 202 BINARY_TOC             = NO
 203 TOC_EXPAND             = YES
 204 GENERATE_QHP           = NO
 205 QCH_FILE               =
 206 QHP_NAMESPACE          = org.doxygen.Project
 207 QHP_VIRTUAL_FOLDER     = doc
 208 QHP_CUST_FILTER_NAME   =
 209 QHP_CUST_FILTER_ATTRS  =
 210 QHP_SECT_FILTER_ATTRS  =
 211 QHG_LOCATION           =
 212 GENERATE_ECLIPSEHELP   = NO
 213 ECLIPSE_DOC_ID         = org.doxygen.Project
 214 DISABLE_INDEX          = NO
 215 GENERATE_TREEVIEW      = YES
 216 ENUM_VALUES_PER_LINE   = 4
 217 TREEVIEW_WIDTH         = 250
 218 EXT_LINKS_IN_WINDOW    = NO
 219 FORMULA_FONTSIZE       = 10
 220 FORMULA_TRANSPARENT    = YES
 221 USE_MATHJAX            = NO
 222 MATHJAX_FORMAT         = HTML-CSS
 223 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
 224 MATHJAX_EXTENSIONS     =
 225 MATHJAX_CODEFILE       =
 226 SEARCHENGINE           = YES
 227 SERVER_BASED_SEARCH    = YES
 228 EXTERNAL_SEARCH        = NO
 229 SEARCHENGINE_URL       =
 230 SEARCHDATA_FILE        = searchdata.xml
 231 EXTERNAL_SEARCH_ID     =
 232 EXTRA_SEARCH_MAPPINGS  =
 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 options related to external references
 247 #---------------------------------------------------------------------------
 248 TAGFILES               =
 249 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
 250 ALLEXTERNALS           = NO
 251 EXTERNAL_GROUPS        = YES
 252 EXTERNAL_PAGES         = YES
 253 #---------------------------------------------------------------------------
 254 # Configuration options related to the dot tool
 255 #---------------------------------------------------------------------------
 256 CLASS_DIAGRAMS         = NO
 257 MSCGEN_PATH            =
 258 DIA_PATH               =
 259 HIDE_UNDOC_RELATIONS   = YES
 260 HAVE_DOT               = {{HAVE_DOT}}
 261 DOT_NUM_THREADS        = 0
 262 DOT_FONTNAME           = Helvetica
 263 DOT_FONTSIZE           = 10
 264 DOT_FONTPATH           =
 265 CLASS_GRAPH            = YES
 266 COLLABORATION_GRAPH    = YES
 267 GROUP_GRAPHS           = YES
 268 UML_LOOK               = NO
 269 UML_LIMIT_NUM_FIELDS   = 10
 270 TEMPLATE_RELATIONS     = NO
 271 INCLUDE_GRAPH          = YES
 272 INCLUDED_BY_GRAPH      = YES
 273 CALL_GRAPH             = NO
 274 CALLER_GRAPH           = NO
 275 GRAPHICAL_HIERARCHY    = YES
 276 DIRECTORY_GRAPH        = YES
 277 DOT_IMAGE_FORMAT       = png
 278 INTERACTIVE_SVG        = NO
 279 DOT_PATH               =
 280 DOTFILE_DIRS           =
 281 MSCFILE_DIRS           =
 282 DIAFILE_DIRS           =
 283 DOT_GRAPH_MAX_NODES    = 50
 284 MAX_DOT_GRAPH_DEPTH    = 1000
 285 DOT_TRANSPARENT        = NO
 286 DOT_MULTI_TARGETS      = YES
 287 GENERATE_LEGEND        = YES
 288 DOT_CLEANUP            = YES