Localisation updates from http://translatewiki.net.
[mediawiki.git] / maintenance / Doxyfile
blobe6862acd17d5719c2f0e0f2520175793a885ae1a
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                 "codeCoverageIgnore="
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 BUILTIN_STL_SUPPORT    = NO
73 CPP_CLI_SUPPORT        = NO
74 SIP_SUPPORT            = NO
75 IDL_PROPERTY_SUPPORT   = NO
76 DISTRIBUTE_GROUP_DOC   = YES
77 SUBGROUPING            = YES
78 INLINE_GROUPED_CLASSES = NO
79 INLINE_SIMPLE_STRUCTS  = NO
80 TYPEDEF_HIDES_STRUCT   = NO
81 SYMBOL_CACHE_SIZE      = 0
82 #---------------------------------------------------------------------------
83 # Build related configuration options
84 #---------------------------------------------------------------------------
85 EXTRACT_ALL            = YES
86 EXTRACT_PRIVATE        = YES
87 EXTRACT_STATIC         = YES
88 EXTRACT_LOCAL_CLASSES  = YES
89 EXTRACT_LOCAL_METHODS  = NO
90 EXTRACT_ANON_NSPACES   = NO
91 HIDE_UNDOC_MEMBERS     = NO
92 HIDE_UNDOC_CLASSES     = NO
93 HIDE_FRIEND_COMPOUNDS  = NO
94 HIDE_IN_BODY_DOCS      = YES
95 INTERNAL_DOCS          = NO
96 CASE_SENSE_NAMES       = YES
97 HIDE_SCOPE_NAMES       = NO
98 SHOW_INCLUDE_FILES     = YES
99 FORCE_LOCAL_INCLUDES   = NO
100 INLINE_INFO            = YES
101 SORT_MEMBER_DOCS       = YES
102 SORT_BRIEF_DOCS        = YES
103 SORT_MEMBERS_CTORS_1ST = NO
104 SORT_GROUP_NAMES       = NO
105 SORT_BY_SCOPE_NAME     = NO
106 STRICT_PROTO_MATCHING  = NO
107 GENERATE_TODOLIST      = YES
108 GENERATE_TESTLIST      = YES
109 GENERATE_BUGLIST       = YES
110 GENERATE_DEPRECATEDLIST= YES
111 ENABLED_SECTIONS       =
112 MAX_INITIALIZER_LINES  = 30
113 SHOW_USED_FILES        = YES
114 SHOW_DIRECTORIES       = YES
115 SHOW_FILES             = YES
116 SHOW_NAMESPACES        = NO
117 FILE_VERSION_FILTER    =
118 LAYOUT_FILE            =
119 CITE_BIB_FILES         =
120 #---------------------------------------------------------------------------
121 # configuration options related to warning and progress messages
122 #---------------------------------------------------------------------------
123 QUIET                  = NO
124 WARNINGS               = YES
125 WARN_IF_UNDOCUMENTED   = YES
126 WARN_IF_DOC_ERROR      = YES
127 WARN_NO_PARAMDOC       = NO
128 WARN_FORMAT            = "$file:$line: $text"
129 WARN_LOGFILE           =
130 #---------------------------------------------------------------------------
131 # configuration options related to the input files
132 #---------------------------------------------------------------------------
133 INPUT                  = {{INPUT}}
134 INPUT_ENCODING         = UTF-8
135 FILE_PATTERNS          = *.c \
136                          *.cc \
137                          *.cxx \
138                          *.cpp \
139                          *.c++ \
140                          *.d \
141                          *.java \
142                          *.ii \
143                          *.ixx \
144                          *.ipp \
145                          *.i++ \
146                          *.inl \
147                          *.h \
148                          *.hh \
149                          *.hxx \
150                          *.hpp \
151                          *.h++ \
152                          *.idl \
153                          *.odl \
154                          *.cs \
155                          *.php \
156                          *.php5 \
157                          *.inc \
158                          *.m \
159                          *.mm \
160                          *.dox \
161                          *.py \
162                          *.C \
163                          *.CC \
164                          *.C++ \
165                          *.II \
166                          *.I++ \
167                          *.H \
168                          *.HH \
169                          *.H++ \
170                          *.CS \
171                          *.PHP \
172                          *.PHP5 \
173                          *.M \
174                          *.MM \
175                          *.PY \
176                          *.txt \
177                          README
178 RECURSIVE              = YES
179 EXCLUDE_SYMLINKS       = YES
180 EXCLUDE_PATTERNS       = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
181 EXCLUDE_SYMBOLS        =
182 EXAMPLE_PATH           =
183 EXAMPLE_PATTERNS       = *
184 EXAMPLE_RECURSIVE      = NO
185 IMAGE_PATH             =
186 INPUT_FILTER           = "{{INPUT_FILTER}}"
187 FILTER_PATTERNS        =
188 FILTER_SOURCE_FILES    = NO
189 FILTER_SOURCE_PATTERNS =
190 #---------------------------------------------------------------------------
191 # configuration options related to source browsing
192 #---------------------------------------------------------------------------
193 SOURCE_BROWSER         = YES
194 INLINE_SOURCES         = NO
195 STRIP_CODE_COMMENTS    = YES
196 REFERENCED_BY_RELATION = YES
197 REFERENCES_RELATION    = YES
198 REFERENCES_LINK_SOURCE = YES
199 USE_HTAGS              = NO
200 VERBATIM_HEADERS       = YES
201 #---------------------------------------------------------------------------
202 # configuration options related to the alphabetical class index
203 #---------------------------------------------------------------------------
204 ALPHABETICAL_INDEX     = NO
205 COLS_IN_ALPHA_INDEX    = 5
206 IGNORE_PREFIX          =
207 #---------------------------------------------------------------------------
208 # configuration options related to the HTML output
209 #---------------------------------------------------------------------------
210 GENERATE_HTML          = YES
211 HTML_OUTPUT            = html
212 HTML_FILE_EXTENSION    = .html
213 HTML_HEADER            =
214 HTML_FOOTER            =
215 HTML_STYLESHEET        =
216 HTML_EXTRA_FILES       =
217 HTML_COLORSTYLE_HUE    = 220
218 HTML_COLORSTYLE_SAT    = 100
219 HTML_COLORSTYLE_GAMMA  =  80
220 HTML_TIMESTAMP         = YES
221 HTML_ALIGN_MEMBERS     = YES
222 HTML_DYNAMIC_SECTIONS  = NO
223 GENERATE_DOCSET        = NO
224 DOCSET_FEEDNAME        = "Doxygen generated docs"
225 DOCSET_BUNDLE_ID       = org.doxygen.Project
226 DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
227 DOCSET_PUBLISHER_NAME  = Publisher
228 GENERATE_HTMLHELP      = NO
229 CHM_FILE               =
230 HHC_LOCATION           =
231 GENERATE_CHI           = NO
232 CHM_INDEX_ENCODING     =
233 BINARY_TOC             = NO
234 TOC_EXPAND             = YES
235 GENERATE_QHP           = NO
236 QCH_FILE               =
237 QHP_NAMESPACE          = org.doxygen.Project
238 QHP_VIRTUAL_FOLDER     = doc
239 QHP_CUST_FILTER_NAME   =
240 QHP_CUST_FILTER_ATTRS  =
241 QHP_SECT_FILTER_ATTRS  =
242 QHG_LOCATION           =
243 GENERATE_ECLIPSEHELP   = NO
244 ECLIPSE_DOC_ID         = org.doxygen.Project
245 DISABLE_INDEX          = NO
246 ENUM_VALUES_PER_LINE   = 4
247 GENERATE_TREEVIEW      = YES
248 USE_INLINE_TREES       = YES
249 TREEVIEW_WIDTH         = 250
250 EXT_LINKS_IN_WINDOW    = NO
251 FORMULA_FONTSIZE       = 10
252 FORMULA_TRANSPARENT    = YES
253 USE_MATHJAX            = NO
254 MATHJAX_RELPATH        = http://www.mathjax.org/mathjax
255 MATHJAX_EXTENSIONS     =
256 SEARCHENGINE           = YES
257 SERVER_BASED_SEARCH    = YES
258 #---------------------------------------------------------------------------
259 # configuration options related to the LaTeX output
260 #---------------------------------------------------------------------------
261 GENERATE_LATEX         = NO
262 LATEX_OUTPUT           = latex
263 LATEX_CMD_NAME         = latex
264 MAKEINDEX_CMD_NAME     = makeindex
265 COMPACT_LATEX          = NO
266 PAPER_TYPE             = a4wide
267 EXTRA_PACKAGES         =
268 LATEX_HEADER           =
269 LATEX_FOOTER           =
270 PDF_HYPERLINKS         = YES
271 USE_PDFLATEX           = YES
272 LATEX_BATCHMODE        = NO
273 LATEX_HIDE_INDICES     = NO
274 LATEX_SOURCE_CODE      = NO
275 LATEX_BIB_STYLE        = plain
276 #---------------------------------------------------------------------------
277 # configuration options related to the RTF output
278 #---------------------------------------------------------------------------
279 GENERATE_RTF           = NO
280 RTF_OUTPUT             = rtf
281 COMPACT_RTF            = NO
282 RTF_HYPERLINKS         = NO
283 RTF_STYLESHEET_FILE    =
284 RTF_EXTENSIONS_FILE    =
285 #---------------------------------------------------------------------------
286 # configuration options related to the man page output
287 #---------------------------------------------------------------------------
288 GENERATE_MAN           = {{GENERATE_MAN}}
289 MAN_OUTPUT             = man
290 MAN_EXTENSION          = .3
291 MAN_LINKS              = NO
292 #---------------------------------------------------------------------------
293 # configuration options related to the XML output
294 #---------------------------------------------------------------------------
295 GENERATE_XML           = NO
296 XML_OUTPUT             = xml
297 XML_SCHEMA             =
298 XML_DTD                =
299 XML_PROGRAMLISTING     = YES
300 #---------------------------------------------------------------------------
301 # configuration options for the AutoGen Definitions output
302 #---------------------------------------------------------------------------
303 GENERATE_AUTOGEN_DEF   = NO
304 #---------------------------------------------------------------------------
305 # configuration options related to the Perl module output
306 #---------------------------------------------------------------------------
307 GENERATE_PERLMOD       = NO
308 PERLMOD_LATEX          = NO
309 PERLMOD_PRETTY         = YES
310 PERLMOD_MAKEVAR_PREFIX =
311 #---------------------------------------------------------------------------
312 # Configuration options related to the preprocessor
313 #---------------------------------------------------------------------------
314 ENABLE_PREPROCESSING   = YES
315 MACRO_EXPANSION        = NO
316 EXPAND_ONLY_PREDEF     = NO
317 SEARCH_INCLUDES        = YES
318 INCLUDE_PATH           =
319 INCLUDE_FILE_PATTERNS  =
320 PREDEFINED             =
321 EXPAND_AS_DEFINED      =
322 SKIP_FUNCTION_MACROS   = YES
323 #---------------------------------------------------------------------------
324 # Configuration::additions related to external references
325 #---------------------------------------------------------------------------
326 TAGFILES               =
327 GENERATE_TAGFILE       = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
328 ALLEXTERNALS           = NO
329 EXTERNAL_GROUPS        = YES
330 PERL_PATH              = /usr/bin/perl
331 #---------------------------------------------------------------------------
332 # Configuration options related to the dot tool
333 #---------------------------------------------------------------------------
334 CLASS_DIAGRAMS         = NO
335 MSCGEN_PATH            =
336 HIDE_UNDOC_RELATIONS   = YES
337 HAVE_DOT               = {{HAVE_DOT}}
338 DOT_NUM_THREADS        = 0
339 DOT_FONTNAME           = Helvetica
340 DOT_FONTSIZE           = 10
341 DOT_FONTPATH           =
342 CLASS_GRAPH            = YES
343 COLLABORATION_GRAPH    = YES
344 GROUP_GRAPHS           = YES
345 UML_LOOK               = NO
346 TEMPLATE_RELATIONS     = NO
347 INCLUDE_GRAPH          = YES
348 INCLUDED_BY_GRAPH      = YES
349 CALL_GRAPH             = NO
350 CALLER_GRAPH           = NO
351 GRAPHICAL_HIERARCHY    = YES
352 DIRECTORY_GRAPH        = YES
353 DOT_IMAGE_FORMAT       = png
354 INTERACTIVE_SVG        = NO
355 DOT_PATH               =
356 DOTFILE_DIRS           =
357 MSCFILE_DIRS           =
358 DOT_GRAPH_MAX_NODES    = 50
359 MAX_DOT_GRAPH_DEPTH    = 1000
360 DOT_TRANSPARENT        = NO
361 DOT_MULTI_TARGETS      = NO
362 GENERATE_LEGEND        = YES
363 DOT_CLEANUP            = YES