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="
71 OPTIMIZE_OUTPUT_FOR_C = NO
72 OPTIMIZE_OUTPUT_JAVA = NO
73 OPTIMIZE_FOR_FORTRAN = NO
74 OPTIMIZE_OUTPUT_VHDL = NO
76 MARKDOWN_SUPPORT = YES
77 AUTOLINK_SUPPORT = YES
78 BUILTIN_STL_SUPPORT = NO
81 IDL_PROPERTY_SUPPORT = YES
82 DISTRIBUTE_GROUP_DOC = YES
84 INLINE_GROUPED_CLASSES = NO
85 INLINE_SIMPLE_STRUCTS = NO
86 TYPEDEF_HIDES_STRUCT = NO
88 #---------------------------------------------------------------------------
89 # Build related configuration options
90 #---------------------------------------------------------------------------
95 EXTRACT_LOCAL_CLASSES = YES
96 EXTRACT_LOCAL_METHODS = NO
97 EXTRACT_ANON_NSPACES = NO
98 HIDE_UNDOC_MEMBERS = NO
99 HIDE_UNDOC_CLASSES = NO
100 HIDE_FRIEND_COMPOUNDS = NO
101 HIDE_IN_BODY_DOCS = YES
103 CASE_SENSE_NAMES = YES
104 HIDE_SCOPE_NAMES = NO
105 SHOW_INCLUDE_FILES = YES
106 SHOW_GROUPED_MEMB_INC = NO
107 FORCE_LOCAL_INCLUDES = NO
109 SORT_MEMBER_DOCS = YES
110 SORT_BRIEF_DOCS = YES
111 SORT_MEMBERS_CTORS_1ST = NO
112 SORT_GROUP_NAMES = NO
113 SORT_BY_SCOPE_NAME = NO
114 STRICT_PROTO_MATCHING = NO
115 GENERATE_TODOLIST = YES
116 GENERATE_TESTLIST = YES
117 GENERATE_BUGLIST = YES
118 GENERATE_DEPRECATEDLIST= YES
120 MAX_INITIALIZER_LINES = 30
121 SHOW_USED_FILES = YES
124 FILE_VERSION_FILTER =
127 #---------------------------------------------------------------------------
128 # Configuration options related to warning and progress messages
129 #---------------------------------------------------------------------------
132 WARN_IF_UNDOCUMENTED = YES
133 WARN_IF_DOC_ERROR = YES
134 WARN_NO_PARAMDOC = NO
135 WARN_FORMAT = "$file:$line: $text"
137 #---------------------------------------------------------------------------
138 # Configuration options related to the input files
139 #---------------------------------------------------------------------------
141 INPUT_ENCODING = UTF-8
142 FILE_PATTERNS = *.c \
186 EXCLUDE = {{EXCLUDE}}
187 EXCLUDE_SYMLINKS = YES
188 EXCLUDE_PATTERNS = LocalSettings.php \
197 EXAMPLE_RECURSIVE = NO
199 INPUT_FILTER = "{{INPUT_FILTER}}"
201 FILTER_SOURCE_FILES = NO
202 FILTER_SOURCE_PATTERNS =
203 USE_MDFILE_AS_MAINPAGE =
204 #---------------------------------------------------------------------------
205 # Configuration options related to source browsing
206 #---------------------------------------------------------------------------
209 STRIP_CODE_COMMENTS = YES
210 REFERENCED_BY_RELATION = YES
211 REFERENCES_RELATION = YES
212 REFERENCES_LINK_SOURCE = YES
213 SOURCE_TOOLTIPS = YES
215 VERBATIM_HEADERS = YES
216 #---------------------------------------------------------------------------
217 # Configuration options related to the alphabetical class index
218 #---------------------------------------------------------------------------
219 ALPHABETICAL_INDEX = NO
220 COLS_IN_ALPHA_INDEX = 5
222 #---------------------------------------------------------------------------
223 # Configuration options related to the HTML output
224 #---------------------------------------------------------------------------
227 HTML_FILE_EXTENSION = .html
231 HTML_EXTRA_STYLESHEET =
233 HTML_COLORSTYLE_HUE = 220
234 HTML_COLORSTYLE_SAT = 100
235 HTML_COLORSTYLE_GAMMA = 80
237 HTML_DYNAMIC_SECTIONS = NO
238 HTML_INDEX_NUM_ENTRIES = 100
240 DOCSET_FEEDNAME = "Doxygen generated docs"
241 DOCSET_BUNDLE_ID = org.doxygen.Project
242 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
243 DOCSET_PUBLISHER_NAME = Publisher
244 GENERATE_HTMLHELP = NO
253 QHP_NAMESPACE = org.doxygen.Project
254 QHP_VIRTUAL_FOLDER = doc
255 QHP_CUST_FILTER_NAME =
256 QHP_CUST_FILTER_ATTRS =
257 QHP_SECT_FILTER_ATTRS =
259 GENERATE_ECLIPSEHELP = NO
260 ECLIPSE_DOC_ID = org.doxygen.Project
262 GENERATE_TREEVIEW = YES
263 ENUM_VALUES_PER_LINE = 4
265 EXT_LINKS_IN_WINDOW = NO
266 FORMULA_FONTSIZE = 10
267 FORMULA_TRANSPARENT = YES
269 MATHJAX_FORMAT = HTML-CSS
270 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
274 SERVER_BASED_SEARCH = YES
277 SEARCHDATA_FILE = searchdata.xml
279 EXTRA_SEARCH_MAPPINGS =
280 #---------------------------------------------------------------------------
281 # Configuration options related to the LaTeX output
282 #---------------------------------------------------------------------------
285 LATEX_CMD_NAME = latex
286 MAKEINDEX_CMD_NAME = makeindex
296 LATEX_HIDE_INDICES = NO
297 LATEX_SOURCE_CODE = NO
298 LATEX_BIB_STYLE = plain
299 #---------------------------------------------------------------------------
300 # Configuration options related to the RTF output
301 #---------------------------------------------------------------------------
306 RTF_STYLESHEET_FILE =
307 RTF_EXTENSIONS_FILE =
308 #---------------------------------------------------------------------------
309 # Configuration options related to the man page output
310 #---------------------------------------------------------------------------
311 GENERATE_MAN = {{GENERATE_MAN}}
315 #---------------------------------------------------------------------------
316 # Configuration options related to the XML output
317 #---------------------------------------------------------------------------
322 XML_PROGRAMLISTING = YES
323 #---------------------------------------------------------------------------
324 # Configuration options related to the DOCBOOK output
325 #---------------------------------------------------------------------------
326 GENERATE_DOCBOOK = NO
327 DOCBOOK_OUTPUT = docbook
328 #---------------------------------------------------------------------------
329 # Configuration options for the AutoGen Definitions output
330 #---------------------------------------------------------------------------
331 GENERATE_AUTOGEN_DEF = NO
332 #---------------------------------------------------------------------------
333 # Configuration options related to the Perl module output
334 #---------------------------------------------------------------------------
335 GENERATE_PERLMOD = NO
338 PERLMOD_MAKEVAR_PREFIX =
339 #---------------------------------------------------------------------------
340 # Configuration options related to the preprocessor
341 #---------------------------------------------------------------------------
342 ENABLE_PREPROCESSING = YES
344 EXPAND_ONLY_PREDEF = NO
345 SEARCH_INCLUDES = YES
347 INCLUDE_FILE_PATTERNS =
350 SKIP_FUNCTION_MACROS = YES
351 #---------------------------------------------------------------------------
352 # Configuration options related to external references
353 #---------------------------------------------------------------------------
355 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
357 EXTERNAL_GROUPS = YES
359 PERL_PATH = /usr/bin/perl
360 #---------------------------------------------------------------------------
361 # Configuration options related to the dot tool
362 #---------------------------------------------------------------------------
366 HIDE_UNDOC_RELATIONS = YES
367 HAVE_DOT = {{HAVE_DOT}}
369 DOT_FONTNAME = Helvetica
373 COLLABORATION_GRAPH = YES
376 UML_LIMIT_NUM_FIELDS = 10
377 TEMPLATE_RELATIONS = NO
379 INCLUDED_BY_GRAPH = YES
382 GRAPHICAL_HIERARCHY = YES
383 DIRECTORY_GRAPH = YES
384 DOT_IMAGE_FORMAT = png
390 DOT_GRAPH_MAX_NODES = 50
391 MAX_DOT_GRAPH_DEPTH = 1000
393 DOT_MULTI_TARGETS = YES
394 GENERATE_LEGEND = YES