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" \
70 OPTIMIZE_OUTPUT_FOR_C = NO
71 OPTIMIZE_OUTPUT_JAVA = NO
72 OPTIMIZE_FOR_FORTRAN = NO
73 OPTIMIZE_OUTPUT_VHDL = NO
75 BUILTIN_STL_SUPPORT = NO
78 IDL_PROPERTY_SUPPORT = YES
79 DISTRIBUTE_GROUP_DOC = YES
81 INLINE_GROUPED_CLASSES = NO
82 INLINE_SIMPLE_STRUCTS = NO
83 TYPEDEF_HIDES_STRUCT = NO
86 #---------------------------------------------------------------------------
87 # Build related configuration options
88 #---------------------------------------------------------------------------
92 EXTRACT_LOCAL_CLASSES = YES
93 EXTRACT_LOCAL_METHODS = NO
94 EXTRACT_ANON_NSPACES = NO
95 HIDE_UNDOC_MEMBERS = NO
96 HIDE_UNDOC_CLASSES = NO
97 HIDE_FRIEND_COMPOUNDS = NO
98 HIDE_IN_BODY_DOCS = YES
100 CASE_SENSE_NAMES = YES
101 HIDE_SCOPE_NAMES = NO
102 SHOW_INCLUDE_FILES = YES
103 FORCE_LOCAL_INCLUDES = NO
105 SORT_MEMBER_DOCS = YES
106 SORT_BRIEF_DOCS = YES
107 SORT_MEMBERS_CTORS_1ST = NO
108 SORT_GROUP_NAMES = NO
109 SORT_BY_SCOPE_NAME = NO
110 STRICT_PROTO_MATCHING = NO
111 GENERATE_TODOLIST = YES
112 GENERATE_TESTLIST = YES
113 GENERATE_BUGLIST = YES
114 GENERATE_DEPRECATEDLIST= YES
116 MAX_INITIALIZER_LINES = 30
117 SHOW_USED_FILES = YES
118 SHOW_DIRECTORIES = YES
121 FILE_VERSION_FILTER =
124 #---------------------------------------------------------------------------
125 # configuration options related to warning and progress messages
126 #---------------------------------------------------------------------------
129 WARN_IF_UNDOCUMENTED = YES
130 WARN_IF_DOC_ERROR = YES
131 WARN_NO_PARAMDOC = NO
132 WARN_FORMAT = "$file:$line: $text"
134 #---------------------------------------------------------------------------
135 # configuration options related to the input files
136 #---------------------------------------------------------------------------
138 INPUT_ENCODING = UTF-8
139 FILE_PATTERNS = *.c \
183 EXCLUDE = {{EXCLUDE}}
184 EXCLUDE_SYMLINKS = YES
185 EXCLUDE_PATTERNS = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
189 EXAMPLE_RECURSIVE = NO
191 INPUT_FILTER = "{{INPUT_FILTER}}"
193 FILTER_SOURCE_FILES = NO
194 FILTER_SOURCE_PATTERNS =
195 #---------------------------------------------------------------------------
196 # configuration options related to source browsing
197 #---------------------------------------------------------------------------
200 STRIP_CODE_COMMENTS = YES
201 REFERENCED_BY_RELATION = YES
202 REFERENCES_RELATION = YES
203 REFERENCES_LINK_SOURCE = YES
205 VERBATIM_HEADERS = YES
206 #---------------------------------------------------------------------------
207 # configuration options related to the alphabetical class index
208 #---------------------------------------------------------------------------
209 ALPHABETICAL_INDEX = NO
210 COLS_IN_ALPHA_INDEX = 5
212 #---------------------------------------------------------------------------
213 # configuration options related to the HTML output
214 #---------------------------------------------------------------------------
217 HTML_FILE_EXTENSION = .html
222 HTML_COLORSTYLE_HUE = 220
223 HTML_COLORSTYLE_SAT = 100
224 HTML_COLORSTYLE_GAMMA = 80
226 HTML_ALIGN_MEMBERS = YES
227 HTML_DYNAMIC_SECTIONS = NO
229 DOCSET_FEEDNAME = "Doxygen generated docs"
230 DOCSET_BUNDLE_ID = org.doxygen.Project
231 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
232 DOCSET_PUBLISHER_NAME = Publisher
233 GENERATE_HTMLHELP = NO
242 QHP_NAMESPACE = org.doxygen.Project
243 QHP_VIRTUAL_FOLDER = doc
244 QHP_CUST_FILTER_NAME =
245 QHP_CUST_FILTER_ATTRS =
246 QHP_SECT_FILTER_ATTRS =
248 GENERATE_ECLIPSEHELP = NO
249 ECLIPSE_DOC_ID = org.doxygen.Project
251 ENUM_VALUES_PER_LINE = 4
252 GENERATE_TREEVIEW = YES
253 USE_INLINE_TREES = YES
255 EXT_LINKS_IN_WINDOW = NO
256 FORMULA_FONTSIZE = 10
257 FORMULA_TRANSPARENT = YES
259 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
262 SERVER_BASED_SEARCH = YES
263 #---------------------------------------------------------------------------
264 # configuration options related to the LaTeX output
265 #---------------------------------------------------------------------------
268 LATEX_CMD_NAME = latex
269 MAKEINDEX_CMD_NAME = makeindex
278 LATEX_HIDE_INDICES = NO
279 LATEX_SOURCE_CODE = NO
280 LATEX_BIB_STYLE = plain
281 #---------------------------------------------------------------------------
282 # configuration options related to the RTF output
283 #---------------------------------------------------------------------------
288 RTF_STYLESHEET_FILE =
289 RTF_EXTENSIONS_FILE =
290 #---------------------------------------------------------------------------
291 # configuration options related to the man page output
292 #---------------------------------------------------------------------------
293 GENERATE_MAN = {{GENERATE_MAN}}
297 #---------------------------------------------------------------------------
298 # configuration options related to the XML output
299 #---------------------------------------------------------------------------
304 XML_PROGRAMLISTING = YES
305 #---------------------------------------------------------------------------
306 # configuration options for the AutoGen Definitions output
307 #---------------------------------------------------------------------------
308 GENERATE_AUTOGEN_DEF = NO
309 #---------------------------------------------------------------------------
310 # configuration options related to the Perl module output
311 #---------------------------------------------------------------------------
312 GENERATE_PERLMOD = NO
315 PERLMOD_MAKEVAR_PREFIX =
316 #---------------------------------------------------------------------------
317 # Configuration options related to the preprocessor
318 #---------------------------------------------------------------------------
319 ENABLE_PREPROCESSING = YES
321 EXPAND_ONLY_PREDEF = NO
322 SEARCH_INCLUDES = YES
324 INCLUDE_FILE_PATTERNS =
327 SKIP_FUNCTION_MACROS = YES
328 #---------------------------------------------------------------------------
329 # Configuration::additions related to external references
330 #---------------------------------------------------------------------------
332 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
334 EXTERNAL_GROUPS = YES
335 PERL_PATH = /usr/bin/perl
336 #---------------------------------------------------------------------------
337 # Configuration options related to the dot tool
338 #---------------------------------------------------------------------------
341 HIDE_UNDOC_RELATIONS = YES
342 HAVE_DOT = {{HAVE_DOT}}
344 DOT_FONTNAME = Helvetica
348 COLLABORATION_GRAPH = YES
351 TEMPLATE_RELATIONS = NO
353 INCLUDED_BY_GRAPH = YES
356 GRAPHICAL_HIERARCHY = YES
357 DIRECTORY_GRAPH = YES
358 DOT_IMAGE_FORMAT = png
363 DOT_GRAPH_MAX_NODES = 50
364 MAX_DOT_GRAPH_DEPTH = 1000
366 DOT_MULTI_TARGETS = YES
367 GENERATE_LEGEND = YES