Merge "Disable transaction warnings for automatic trx."
[mediawiki.git] / maintenance / Doxyfile
blobe3ba4e5a1d15678757ec740f47a8b9e084e9b843
1 # Doxyfile 1.7.5.1
4 # Some placeholders have been added for MediaWiki usage:
5 # {{OUTPUT_DIRECTORY}}
6 # {{CURRENT_VERSION}}
7 # {{STRIP_FROM_PATH}}
8 # {{INPUT}}
10 # To generate documentation run: php mwdocgen.php --no-extensions
12 #---------------------------------------------------------------------------
13 # Project related configuration options
14 #---------------------------------------------------------------------------
15 DOXYFILE_ENCODING      = UTF-8
16 PROJECT_NAME           = MediaWiki
17 PROJECT_NUMBER         = {{CURRENT_VERSION}}
18 PROJECT_BRIEF          =
19 PROJECT_LOGO           =
20 OUTPUT_DIRECTORY       = {{OUTPUT_DIRECTORY}}
21 CREATE_SUBDIRS         = NO
22 OUTPUT_LANGUAGE        = English
23 BRIEF_MEMBER_DESC      = YES
24 REPEAT_BRIEF           = YES
25 ABBREVIATE_BRIEF       = "The $name class" \
26                          "The $name widget" \
27                          "The $name file" \
28                          is \
29                          provides \
30                          specifies \
31                          contains \
32                          represents \
33                          a \
34                          an \
35                          the
36 ALWAYS_DETAILED_SEC    = NO
37 INLINE_INHERITED_MEMB  = NO
38 FULL_PATH_NAMES        = YES
39 STRIP_FROM_PATH        = {{STRIP_FROM_PATH}}
40 STRIP_FROM_INC_PATH    =
41 SHORT_NAMES            = NO
42 JAVADOC_AUTOBRIEF      = YES
43 QT_AUTOBRIEF           = NO
44 MULTILINE_CPP_IS_BRIEF = NO
45 INHERIT_DOCS           = YES
46 SEPARATE_MEMBER_PAGES  = NO
47 TAB_SIZE               = 8
48 ALIASES =       "type{1}=<b> \1 </b>:" \
49                 "types{2}=<b> \1 </b> or <b> \2 </b>:" \
50                 "types{3}=<b> \1 </b>, <b> \2 </b>, or <b> \3 </b>:" \
51                 "arrayof{2}=<b> Array </b> of \2" \
52                 "null=\type{Null}" \
53                 "boolean=\type{Boolean}" \
54                 "bool=\type{Boolean}" \
55                 "integer=\type{Integer}" \
56                 "int=\type{Integer}" \
57                 "string=\type{String}" \
58                 "str=\type{String}" \
59                 "mixed=\type{Mixed}" \
60                 "access=\par Access:\n" \
61                 "private=\access private" \
62                 "protected=\access protected" \
63                 "public=\access public" \
64                 "copyright=\note" \
65                 "license=\note"
66 OPTIMIZE_OUTPUT_FOR_C  = NO
67 OPTIMIZE_OUTPUT_JAVA   = NO
68 OPTIMIZE_FOR_FORTRAN   = NO
69 OPTIMIZE_OUTPUT_VHDL   = NO
70 EXTENSION_MAPPING      =
71 BUILTIN_STL_SUPPORT    = NO
72 CPP_CLI_SUPPORT        = NO
73 SIP_SUPPORT            = NO
74 IDL_PROPERTY_SUPPORT   = NO
75 DISTRIBUTE_GROUP_DOC   = YES
76 SUBGROUPING            = YES
77 INLINE_GROUPED_CLASSES = NO
78 INLINE_SIMPLE_STRUCTS  = NO
79 TYPEDEF_HIDES_STRUCT   = NO
80 SYMBOL_CACHE_SIZE      = 0
81 #---------------------------------------------------------------------------
82 # Build related configuration options
83 #---------------------------------------------------------------------------
84 EXTRACT_ALL            = YES
85 EXTRACT_PRIVATE        = YES
86 EXTRACT_STATIC         = YES
87 EXTRACT_LOCAL_CLASSES  = YES
88 EXTRACT_LOCAL_METHODS  = NO
89 EXTRACT_ANON_NSPACES   = NO
90 HIDE_UNDOC_MEMBERS     = NO
91 HIDE_UNDOC_CLASSES     = NO
92 HIDE_FRIEND_COMPOUNDS  = NO
93 HIDE_IN_BODY_DOCS      = YES
94 INTERNAL_DOCS          = NO
95 CASE_SENSE_NAMES       = YES
96 HIDE_SCOPE_NAMES       = NO
97 SHOW_INCLUDE_FILES     = YES
98 FORCE_LOCAL_INCLUDES   = NO
99 INLINE_INFO            = YES
100 SORT_MEMBER_DOCS       = YES
101 SORT_BRIEF_DOCS        = YES
102 SORT_MEMBERS_CTORS_1ST = NO
103 SORT_GROUP_NAMES       = NO
104 SORT_BY_SCOPE_NAME     = NO
105 STRICT_PROTO_MATCHING  = NO
106 GENERATE_TODOLIST      = YES
107 GENERATE_TESTLIST      = YES
108 GENERATE_BUGLIST       = YES
109 GENERATE_DEPRECATEDLIST= YES
110 ENABLED_SECTIONS       =
111 MAX_INITIALIZER_LINES  = 30
112 SHOW_USED_FILES        = YES
113 SHOW_DIRECTORIES       = YES
114 SHOW_FILES             = YES
115 SHOW_NAMESPACES        = NO
116 FILE_VERSION_FILTER    =
117 LAYOUT_FILE            =
118 CITE_BIB_FILES         =
119 #---------------------------------------------------------------------------
120 # configuration options related to warning and progress messages
121 #---------------------------------------------------------------------------
122 QUIET                  = NO
123 WARNINGS               = YES
124 WARN_IF_UNDOCUMENTED   = YES
125 WARN_IF_DOC_ERROR      = YES
126 WARN_NO_PARAMDOC       = NO
127 WARN_FORMAT            = "$file:$line: $text"
128 WARN_LOGFILE           =
129 #---------------------------------------------------------------------------
130 # configuration options related to the input files
131 #---------------------------------------------------------------------------
132 INPUT                  = {{INPUT}}
133 INPUT_ENCODING         = UTF-8
134 FILE_PATTERNS          = *.c \
135                          *.cc \
136                          *.cxx \
137                          *.cpp \
138                          *.c++ \
139                          *.d \
140                          *.java \
141                          *.ii \
142                          *.ixx \
143                          *.ipp \
144                          *.i++ \
145                          *.inl \
146                          *.h \
147                          *.hh \
148                          *.hxx \
149                          *.hpp \
150                          *.h++ \
151                          *.idl \
152                          *.odl \
153                          *.cs \
154                          *.php \
155                          *.php5 \
156                          *.inc \
157                          *.m \
158                          *.mm \
159                          *.dox \
160                          *.py \
161                          *.C \
162                          *.CC \
163                          *.C++ \
164                          *.II \
165                          *.I++ \
166                          *.H \
167                          *.HH \
168                          *.H++ \
169                          *.CS \
170                          *.PHP \
171                          *.PHP5 \
172                          *.M \
173                          *.MM \
174                          *.PY
175 RECURSIVE              = YES
176 EXCLUDE_SYMLINKS       = YES
177 EXCLUDE_PATTERNS       = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
178 EXCLUDE_SYMBOLS        =
179 EXAMPLE_PATH           =
180 EXAMPLE_PATTERNS       = *
181 EXAMPLE_RECURSIVE      = NO
182 IMAGE_PATH             =
183 INPUT_FILTER           = "{{INPUT_FILTER}}"
184 FILTER_PATTERNS        =
185 FILTER_SOURCE_FILES    = NO
186 FILTER_SOURCE_PATTERNS =
187 #---------------------------------------------------------------------------
188 # configuration options related to source browsing
189 #---------------------------------------------------------------------------
190 SOURCE_BROWSER         = YES
191 INLINE_SOURCES         = NO
192 STRIP_CODE_COMMENTS    = YES
193 REFERENCED_BY_RELATION = YES
194 REFERENCES_RELATION    = YES
195 REFERENCES_LINK_SOURCE = YES
196 USE_HTAGS              = NO
197 VERBATIM_HEADERS       = YES
198 #---------------------------------------------------------------------------
199 # configuration options related to the alphabetical class index
200 #---------------------------------------------------------------------------
201 ALPHABETICAL_INDEX     = NO
202 COLS_IN_ALPHA_INDEX    = 5
203 IGNORE_PREFIX          =
204 #---------------------------------------------------------------------------
205 # configuration options related to the HTML output
206 #---------------------------------------------------------------------------
207 GENERATE_HTML          = YES
208 HTML_OUTPUT            = html
209 HTML_FILE_EXTENSION    = .html
210 HTML_HEADER            =
211 HTML_FOOTER            =
212 HTML_STYLESHEET        =
213 HTML_EXTRA_FILES       =
214 HTML_COLORSTYLE_HUE    = 220
215 HTML_COLORSTYLE_SAT    = 100
216 HTML_COLORSTYLE_GAMMA  =  80
217 HTML_TIMESTAMP         = YES
218 HTML_ALIGN_MEMBERS     = YES
219 HTML_DYNAMIC_SECTIONS  = NO
220 GENERATE_DOCSET        = NO
221 DOCSET_FEEDNAME        = "Doxygen generated docs"
222 DOCSET_BUNDLE_ID       = org.doxygen.Project
223 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
224 DOCSET_PUBLISHER_NAME  = Publisher
225 GENERATE_HTMLHELP      = NO
226 CHM_FILE               =
227 HHC_LOCATION           =
228 GENERATE_CHI           = NO
229 CHM_INDEX_ENCODING     =
230 BINARY_TOC             = NO
231 TOC_EXPAND             = YES
232 GENERATE_QHP           = NO
233 QCH_FILE               =
234 QHP_NAMESPACE          = org.doxygen.Project
235 QHP_VIRTUAL_FOLDER     = doc
236 QHP_CUST_FILTER_NAME   =
237 QHP_CUST_FILTER_ATTRS  =
238 QHP_SECT_FILTER_ATTRS  =
239 QHG_LOCATION           =
240 GENERATE_ECLIPSEHELP   = NO
241 ECLIPSE_DOC_ID         = org.doxygen.Project
242 DISABLE_INDEX          = NO
243 ENUM_VALUES_PER_LINE   = 4
244 GENERATE_TREEVIEW      = YES
245 USE_INLINE_TREES       = YES
246 TREEVIEW_WIDTH         = 250
247 EXT_LINKS_IN_WINDOW    = NO
248 FORMULA_FONTSIZE       = 10
249 FORMULA_TRANSPARENT    = YES
250 USE_MATHJAX            = NO
251 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
252 MATHJAX_EXTENSIONS     =
253 SEARCHENGINE           = YES
254 SERVER_BASED_SEARCH    = YES
255 #---------------------------------------------------------------------------
256 # configuration options related to the LaTeX output
257 #---------------------------------------------------------------------------
258 GENERATE_LATEX         = NO
259 LATEX_OUTPUT           = latex
260 LATEX_CMD_NAME         = latex
261 MAKEINDEX_CMD_NAME     = makeindex
262 COMPACT_LATEX          = NO
263 PAPER_TYPE             = a4wide
264 EXTRA_PACKAGES         =
265 LATEX_HEADER           =
266 LATEX_FOOTER           =
267 PDF_HYPERLINKS         = YES
268 USE_PDFLATEX           = YES
269 LATEX_BATCHMODE        = NO
270 LATEX_HIDE_INDICES     = NO
271 LATEX_SOURCE_CODE      = NO
272 LATEX_BIB_STYLE        = plain
273 #---------------------------------------------------------------------------
274 # configuration options related to the RTF output
275 #---------------------------------------------------------------------------
276 GENERATE_RTF           = NO
277 RTF_OUTPUT             = rtf
278 COMPACT_RTF            = NO
279 RTF_HYPERLINKS         = NO
280 RTF_STYLESHEET_FILE    =
281 RTF_EXTENSIONS_FILE    =
282 #---------------------------------------------------------------------------
283 # configuration options related to the man page output
284 #---------------------------------------------------------------------------
285 GENERATE_MAN           = {{GENERATE_MAN}}
286 MAN_OUTPUT             = man
287 MAN_EXTENSION          = .3
288 MAN_LINKS              = NO
289 #---------------------------------------------------------------------------
290 # configuration options related to the XML output
291 #---------------------------------------------------------------------------
292 GENERATE_XML           = NO
293 XML_OUTPUT             = xml
294 XML_SCHEMA             =
295 XML_DTD                =
296 XML_PROGRAMLISTING     = YES
297 #---------------------------------------------------------------------------
298 # configuration options for the AutoGen Definitions output
299 #---------------------------------------------------------------------------
300 GENERATE_AUTOGEN_DEF   = NO
301 #---------------------------------------------------------------------------
302 # configuration options related to the Perl module output
303 #---------------------------------------------------------------------------
304 GENERATE_PERLMOD       = NO
305 PERLMOD_LATEX          = NO
306 PERLMOD_PRETTY         = YES
307 PERLMOD_MAKEVAR_PREFIX =
308 #---------------------------------------------------------------------------
309 # Configuration options related to the preprocessor
310 #---------------------------------------------------------------------------
311 ENABLE_PREPROCESSING   = YES
312 MACRO_EXPANSION        = NO
313 EXPAND_ONLY_PREDEF     = NO
314 SEARCH_INCLUDES        = YES
315 INCLUDE_PATH           =
316 INCLUDE_FILE_PATTERNS  =
317 PREDEFINED             =
318 EXPAND_AS_DEFINED      =
319 SKIP_FUNCTION_MACROS   = YES
320 #---------------------------------------------------------------------------
321 # Configuration::additions related to external references
322 #---------------------------------------------------------------------------
323 TAGFILES               =
324 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
325 ALLEXTERNALS           = NO
326 EXTERNAL_GROUPS        = YES
327 PERL_PATH              = /usr/bin/perl
328 #---------------------------------------------------------------------------
329 # Configuration options related to the dot tool
330 #---------------------------------------------------------------------------
331 CLASS_DIAGRAMS         = NO
332 MSCGEN_PATH            =
333 HIDE_UNDOC_RELATIONS   = YES
334 HAVE_DOT               = {{HAVE_DOT}}
335 DOT_NUM_THREADS        = 0
336 DOT_FONTNAME           = Helvetica
337 DOT_FONTSIZE           = 10
338 DOT_FONTPATH           =
339 CLASS_GRAPH            = YES
340 COLLABORATION_GRAPH    = YES
341 GROUP_GRAPHS           = YES
342 UML_LOOK               = NO
343 TEMPLATE_RELATIONS     = NO
344 INCLUDE_GRAPH          = YES
345 INCLUDED_BY_GRAPH      = YES
346 CALL_GRAPH             = NO
347 CALLER_GRAPH           = NO
348 GRAPHICAL_HIERARCHY    = YES
349 DIRECTORY_GRAPH        = YES
350 DOT_IMAGE_FORMAT       = png
351 INTERACTIVE_SVG        = NO
352 DOT_PATH               =
353 DOTFILE_DIRS           =
354 MSCFILE_DIRS           =
355 DOT_GRAPH_MAX_NODES    = 50
356 MAX_DOT_GRAPH_DEPTH    = 1000
357 DOT_TRANSPARENT        = NO
358 DOT_MULTI_TARGETS      = NO
359 GENERATE_LEGEND        = YES
360 DOT_CLEANUP            = YES