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:
7 # OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}}
8 # CURRENT_VERSION = {{CURRENT_VERSION}}
9 # STRIP_FROM_PATH = {{STRIP_FROM_PATH}}
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 "access=\par Access:\n" \
54 "private=\access private" \
55 "protected=\access protected" \
58 "inheritDoc=\inheritdoc" \
59 "codeCoverageIgnore=" \
60 "codingStandardsIgnoreStart=" \
64 "expectedException=" \
65 "expectedExceptionMessage="
67 OPTIMIZE_OUTPUT_FOR_C = NO
68 OPTIMIZE_OUTPUT_JAVA = NO
69 OPTIMIZE_FOR_FORTRAN = NO
70 OPTIMIZE_OUTPUT_VHDL = NO
72 MARKDOWN_SUPPORT = YES
73 AUTOLINK_SUPPORT = YES
74 BUILTIN_STL_SUPPORT = NO
77 IDL_PROPERTY_SUPPORT = YES
78 DISTRIBUTE_GROUP_DOC = YES
80 INLINE_GROUPED_CLASSES = NO
81 INLINE_SIMPLE_STRUCTS = NO
82 TYPEDEF_HIDES_STRUCT = NO
84 #---------------------------------------------------------------------------
85 # Build related configuration options
86 #---------------------------------------------------------------------------
91 EXTRACT_LOCAL_CLASSES = YES
92 EXTRACT_LOCAL_METHODS = NO
93 EXTRACT_ANON_NSPACES = NO
94 HIDE_UNDOC_MEMBERS = NO
95 HIDE_UNDOC_CLASSES = NO
96 HIDE_FRIEND_COMPOUNDS = NO
97 HIDE_IN_BODY_DOCS = YES
99 CASE_SENSE_NAMES = YES
100 HIDE_SCOPE_NAMES = NO
101 SHOW_INCLUDE_FILES = YES
102 SHOW_GROUPED_MEMB_INC = NO
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
120 FILE_VERSION_FILTER =
123 #---------------------------------------------------------------------------
124 # Configuration options related to warning and progress messages
125 #---------------------------------------------------------------------------
128 WARN_IF_UNDOCUMENTED = YES
129 WARN_IF_DOC_ERROR = YES
130 WARN_NO_PARAMDOC = NO
131 WARN_FORMAT = "$file:$line: $text"
133 #---------------------------------------------------------------------------
134 # Configuration options related to the input files
135 #---------------------------------------------------------------------------
137 INPUT_ENCODING = UTF-8
138 FILE_PATTERNS = *.php \
142 EXCLUDE = {{EXCLUDE}}
143 EXCLUDE_SYMLINKS = YES
144 EXCLUDE_PATTERNS = LocalSettings.php \
152 EXAMPLE_RECURSIVE = NO
154 INPUT_FILTER = "{{INPUT_FILTER}}"
156 FILTER_SOURCE_FILES = NO
157 FILTER_SOURCE_PATTERNS =
158 USE_MDFILE_AS_MAINPAGE =
159 #---------------------------------------------------------------------------
160 # Configuration options related to source browsing
161 #---------------------------------------------------------------------------
164 STRIP_CODE_COMMENTS = YES
165 REFERENCED_BY_RELATION = YES
166 REFERENCES_RELATION = YES
167 REFERENCES_LINK_SOURCE = YES
168 SOURCE_TOOLTIPS = YES
170 VERBATIM_HEADERS = YES
171 #---------------------------------------------------------------------------
172 # Configuration options related to the alphabetical class index
173 #---------------------------------------------------------------------------
174 ALPHABETICAL_INDEX = NO
175 COLS_IN_ALPHA_INDEX = 5
177 #---------------------------------------------------------------------------
178 # Configuration options related to the HTML output
179 #---------------------------------------------------------------------------
182 HTML_FILE_EXTENSION = .html
186 HTML_EXTRA_STYLESHEET =
188 HTML_COLORSTYLE_HUE = 220
189 HTML_COLORSTYLE_SAT = 100
190 HTML_COLORSTYLE_GAMMA = 80
192 HTML_DYNAMIC_SECTIONS = NO
193 HTML_INDEX_NUM_ENTRIES = 100
195 DOCSET_FEEDNAME = "Doxygen generated docs"
196 DOCSET_BUNDLE_ID = org.doxygen.Project
197 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
198 DOCSET_PUBLISHER_NAME = Publisher
199 GENERATE_HTMLHELP = NO
208 QHP_NAMESPACE = org.doxygen.Project
209 QHP_VIRTUAL_FOLDER = doc
210 QHP_CUST_FILTER_NAME =
211 QHP_CUST_FILTER_ATTRS =
212 QHP_SECT_FILTER_ATTRS =
214 GENERATE_ECLIPSEHELP = NO
215 ECLIPSE_DOC_ID = org.doxygen.Project
217 GENERATE_TREEVIEW = YES
218 ENUM_VALUES_PER_LINE = 4
220 EXT_LINKS_IN_WINDOW = NO
221 FORMULA_FONTSIZE = 10
222 FORMULA_TRANSPARENT = YES
224 MATHJAX_FORMAT = HTML-CSS
225 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
229 SERVER_BASED_SEARCH = YES
232 SEARCHDATA_FILE = searchdata.xml
234 EXTRA_SEARCH_MAPPINGS =
235 #---------------------------------------------------------------------------
236 # Configuration options related to the LaTeX output
237 #---------------------------------------------------------------------------
240 LATEX_CMD_NAME = latex
241 MAKEINDEX_CMD_NAME = makeindex
251 LATEX_HIDE_INDICES = NO
252 LATEX_SOURCE_CODE = NO
253 LATEX_BIB_STYLE = plain
254 #---------------------------------------------------------------------------
255 # Configuration options related to the RTF output
256 #---------------------------------------------------------------------------
261 RTF_STYLESHEET_FILE =
262 RTF_EXTENSIONS_FILE =
263 #---------------------------------------------------------------------------
264 # Configuration options related to the man page output
265 #---------------------------------------------------------------------------
266 GENERATE_MAN = {{GENERATE_MAN}}
270 #---------------------------------------------------------------------------
271 # Configuration options related to the XML output
272 #---------------------------------------------------------------------------
275 XML_PROGRAMLISTING = YES
276 #---------------------------------------------------------------------------
277 # Configuration options related to the DOCBOOK output
278 #---------------------------------------------------------------------------
279 GENERATE_DOCBOOK = NO
280 DOCBOOK_OUTPUT = docbook
281 #---------------------------------------------------------------------------
282 # Configuration options for the AutoGen Definitions output
283 #---------------------------------------------------------------------------
284 GENERATE_AUTOGEN_DEF = NO
285 #---------------------------------------------------------------------------
286 # Configuration options related to the Perl module output
287 #---------------------------------------------------------------------------
288 GENERATE_PERLMOD = NO
291 PERLMOD_MAKEVAR_PREFIX =
292 #---------------------------------------------------------------------------
293 # Configuration options related to the preprocessor
294 #---------------------------------------------------------------------------
295 ENABLE_PREPROCESSING = YES
297 EXPAND_ONLY_PREDEF = NO
298 SEARCH_INCLUDES = YES
300 INCLUDE_FILE_PATTERNS =
303 SKIP_FUNCTION_MACROS = YES
304 #---------------------------------------------------------------------------
305 # Configuration options related to external references
306 #---------------------------------------------------------------------------
308 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
310 EXTERNAL_GROUPS = YES
312 #---------------------------------------------------------------------------
313 # Configuration options related to the dot tool
314 #---------------------------------------------------------------------------
318 HIDE_UNDOC_RELATIONS = YES
319 HAVE_DOT = {{HAVE_DOT}}
321 DOT_FONTNAME = Helvetica
325 COLLABORATION_GRAPH = YES
328 UML_LIMIT_NUM_FIELDS = 10
329 TEMPLATE_RELATIONS = NO
331 INCLUDED_BY_GRAPH = YES
334 GRAPHICAL_HIERARCHY = YES
335 DIRECTORY_GRAPH = YES
336 DOT_IMAGE_FORMAT = png
342 DOT_GRAPH_MAX_NODES = 50
343 MAX_DOT_GRAPH_DEPTH = 1000
345 DOT_MULTI_TARGETS = YES
346 GENERATE_LEGEND = YES