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