3 # This file describes the settings to be used by the documentation system
4 # doxygen (www.doxygen.org) for MediaWiki.
6 # Some placeholders have been added for MediaWiki usage:
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}}
22 OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}}
24 OUTPUT_LANGUAGE = English
25 BRIEF_MEMBER_DESC = YES
27 ABBREVIATE_BRIEF = "The $name class" \
38 ALWAYS_DETAILED_SEC = NO
39 INLINE_INHERITED_MEMB = NO
41 STRIP_FROM_PATH = {{STRIP_FROM_PATH}}
44 JAVADOC_AUTOBRIEF = YES
46 MULTILINE_CPP_IS_BRIEF = NO
48 SEPARATE_MEMBER_PAGES = NO
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" \
55 "boolean=\type{Boolean}" \
56 "bool=\type{Boolean}" \
57 "integer=\type{Integer}" \
58 "int=\type{Integer}" \
59 "string=\type{String}" \
61 "mixed=\type{Mixed}" \
62 "access=\par Access:\n" \
63 "private=\access private" \
64 "protected=\access protected" \
65 "public=\access public" \
68 "codeCoverageIgnore=" \
69 "codingStandardsIgnoreStart=" \
73 "expectedException=" \
74 "expectedExceptionMessage="
76 OPTIMIZE_OUTPUT_FOR_C = NO
77 OPTIMIZE_OUTPUT_JAVA = NO
78 OPTIMIZE_FOR_FORTRAN = NO
79 OPTIMIZE_OUTPUT_VHDL = NO
81 MARKDOWN_SUPPORT = YES
82 AUTOLINK_SUPPORT = YES
83 BUILTIN_STL_SUPPORT = NO
86 IDL_PROPERTY_SUPPORT = YES
87 DISTRIBUTE_GROUP_DOC = YES
89 INLINE_GROUPED_CLASSES = NO
90 INLINE_SIMPLE_STRUCTS = NO
91 TYPEDEF_HIDES_STRUCT = NO
93 #---------------------------------------------------------------------------
94 # Build related configuration options
95 #---------------------------------------------------------------------------
100 EXTRACT_LOCAL_CLASSES = YES
101 EXTRACT_LOCAL_METHODS = NO
102 EXTRACT_ANON_NSPACES = NO
103 HIDE_UNDOC_MEMBERS = NO
104 HIDE_UNDOC_CLASSES = NO
105 HIDE_FRIEND_COMPOUNDS = NO
106 HIDE_IN_BODY_DOCS = YES
108 CASE_SENSE_NAMES = YES
109 HIDE_SCOPE_NAMES = NO
110 SHOW_INCLUDE_FILES = YES
111 SHOW_GROUPED_MEMB_INC = NO
112 FORCE_LOCAL_INCLUDES = NO
114 SORT_MEMBER_DOCS = YES
115 SORT_BRIEF_DOCS = YES
116 SORT_MEMBERS_CTORS_1ST = NO
117 SORT_GROUP_NAMES = NO
118 SORT_BY_SCOPE_NAME = NO
119 STRICT_PROTO_MATCHING = NO
120 GENERATE_TODOLIST = YES
121 GENERATE_TESTLIST = YES
122 GENERATE_BUGLIST = YES
123 GENERATE_DEPRECATEDLIST= YES
125 MAX_INITIALIZER_LINES = 30
126 SHOW_USED_FILES = YES
129 FILE_VERSION_FILTER =
132 #---------------------------------------------------------------------------
133 # Configuration options related to warning and progress messages
134 #---------------------------------------------------------------------------
137 WARN_IF_UNDOCUMENTED = YES
138 WARN_IF_DOC_ERROR = YES
139 WARN_NO_PARAMDOC = NO
140 WARN_FORMAT = "$file:$line: $text"
142 #---------------------------------------------------------------------------
143 # Configuration options related to the input files
144 #---------------------------------------------------------------------------
146 INPUT_ENCODING = UTF-8
147 FILE_PATTERNS = *.c \
191 EXCLUDE = {{EXCLUDE}}
192 EXCLUDE_SYMLINKS = YES
193 EXCLUDE_PATTERNS = LocalSettings.php \
202 EXAMPLE_RECURSIVE = NO
204 INPUT_FILTER = "{{INPUT_FILTER}}"
206 FILTER_SOURCE_FILES = NO
207 FILTER_SOURCE_PATTERNS =
208 USE_MDFILE_AS_MAINPAGE =
209 #---------------------------------------------------------------------------
210 # Configuration options related to source browsing
211 #---------------------------------------------------------------------------
214 STRIP_CODE_COMMENTS = YES
215 REFERENCED_BY_RELATION = YES
216 REFERENCES_RELATION = YES
217 REFERENCES_LINK_SOURCE = YES
218 SOURCE_TOOLTIPS = YES
220 VERBATIM_HEADERS = YES
221 #---------------------------------------------------------------------------
222 # Configuration options related to the alphabetical class index
223 #---------------------------------------------------------------------------
224 ALPHABETICAL_INDEX = NO
225 COLS_IN_ALPHA_INDEX = 5
227 #---------------------------------------------------------------------------
228 # Configuration options related to the HTML output
229 #---------------------------------------------------------------------------
232 HTML_FILE_EXTENSION = .html
236 HTML_EXTRA_STYLESHEET =
238 HTML_COLORSTYLE_HUE = 220
239 HTML_COLORSTYLE_SAT = 100
240 HTML_COLORSTYLE_GAMMA = 80
242 HTML_DYNAMIC_SECTIONS = NO
243 HTML_INDEX_NUM_ENTRIES = 100
245 DOCSET_FEEDNAME = "Doxygen generated docs"
246 DOCSET_BUNDLE_ID = org.doxygen.Project
247 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
248 DOCSET_PUBLISHER_NAME = Publisher
249 GENERATE_HTMLHELP = NO
258 QHP_NAMESPACE = org.doxygen.Project
259 QHP_VIRTUAL_FOLDER = doc
260 QHP_CUST_FILTER_NAME =
261 QHP_CUST_FILTER_ATTRS =
262 QHP_SECT_FILTER_ATTRS =
264 GENERATE_ECLIPSEHELP = NO
265 ECLIPSE_DOC_ID = org.doxygen.Project
267 GENERATE_TREEVIEW = YES
268 ENUM_VALUES_PER_LINE = 4
270 EXT_LINKS_IN_WINDOW = NO
271 FORMULA_FONTSIZE = 10
272 FORMULA_TRANSPARENT = YES
274 MATHJAX_FORMAT = HTML-CSS
275 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
279 SERVER_BASED_SEARCH = YES
282 SEARCHDATA_FILE = searchdata.xml
284 EXTRA_SEARCH_MAPPINGS =
285 #---------------------------------------------------------------------------
286 # Configuration options related to the LaTeX output
287 #---------------------------------------------------------------------------
290 LATEX_CMD_NAME = latex
291 MAKEINDEX_CMD_NAME = makeindex
301 LATEX_HIDE_INDICES = NO
302 LATEX_SOURCE_CODE = NO
303 LATEX_BIB_STYLE = plain
304 #---------------------------------------------------------------------------
305 # Configuration options related to the RTF output
306 #---------------------------------------------------------------------------
311 RTF_STYLESHEET_FILE =
312 RTF_EXTENSIONS_FILE =
313 #---------------------------------------------------------------------------
314 # Configuration options related to the man page output
315 #---------------------------------------------------------------------------
316 GENERATE_MAN = {{GENERATE_MAN}}
320 #---------------------------------------------------------------------------
321 # Configuration options related to the XML output
322 #---------------------------------------------------------------------------
327 XML_PROGRAMLISTING = YES
328 #---------------------------------------------------------------------------
329 # Configuration options related to the DOCBOOK output
330 #---------------------------------------------------------------------------
331 GENERATE_DOCBOOK = NO
332 DOCBOOK_OUTPUT = docbook
333 #---------------------------------------------------------------------------
334 # Configuration options for the AutoGen Definitions output
335 #---------------------------------------------------------------------------
336 GENERATE_AUTOGEN_DEF = NO
337 #---------------------------------------------------------------------------
338 # Configuration options related to the Perl module output
339 #---------------------------------------------------------------------------
340 GENERATE_PERLMOD = NO
343 PERLMOD_MAKEVAR_PREFIX =
344 #---------------------------------------------------------------------------
345 # Configuration options related to the preprocessor
346 #---------------------------------------------------------------------------
347 ENABLE_PREPROCESSING = YES
349 EXPAND_ONLY_PREDEF = NO
350 SEARCH_INCLUDES = YES
352 INCLUDE_FILE_PATTERNS =
355 SKIP_FUNCTION_MACROS = YES
356 #---------------------------------------------------------------------------
357 # Configuration options related to external references
358 #---------------------------------------------------------------------------
360 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
362 EXTERNAL_GROUPS = YES
364 PERL_PATH = /usr/bin/perl
365 #---------------------------------------------------------------------------
366 # Configuration options related to the dot tool
367 #---------------------------------------------------------------------------
371 HIDE_UNDOC_RELATIONS = YES
372 HAVE_DOT = {{HAVE_DOT}}
374 DOT_FONTNAME = Helvetica
378 COLLABORATION_GRAPH = YES
381 UML_LIMIT_NUM_FIELDS = 10
382 TEMPLATE_RELATIONS = NO
384 INCLUDED_BY_GRAPH = YES
387 GRAPHICAL_HIERARCHY = YES
388 DIRECTORY_GRAPH = YES
389 DOT_IMAGE_FORMAT = png
395 DOT_GRAPH_MAX_NODES = 50
396 MAX_DOT_GRAPH_DEPTH = 1000
398 DOT_MULTI_TARGETS = YES
399 GENERATE_LEGEND = YES