4 # Some placeholders have been added for MediaWiki usage:
11 # A number of MediaWiki-specific aliases are near the end of this file.
12 # To generate documentation run: php mwdocgen.php --no-extensions
14 #---------------------------------------------------------------------------
15 # Project related configuration options
16 #---------------------------------------------------------------------------
17 PROJECT_NAME = MediaWiki
18 PROJECT_NUMBER = {{CURRENT_VERSION}}
19 OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}}
21 OUTPUT_LANGUAGE = English
22 BRIEF_MEMBER_DESC = YES
24 ABBREVIATE_BRIEF = "The $name class" \
35 ALWAYS_DETAILED_SEC = NO
36 INLINE_INHERITED_MEMB = NO
38 STRIP_FROM_PATH = {{STRIP_FROM_PATH}}
41 JAVADOC_AUTOBRIEF = YES
42 MULTILINE_CPP_IS_BRIEF = NO
44 SEPARATE_MEMBER_PAGES = NO
46 OPTIMIZE_OUTPUT_FOR_C = NO
47 OPTIMIZE_OUTPUT_JAVA = NO
48 BUILTIN_STL_SUPPORT = NO
49 DISTRIBUTE_GROUP_DOC = YES
51 #---------------------------------------------------------------------------
52 # Build related configuration options
53 #---------------------------------------------------------------------------
57 EXTRACT_LOCAL_CLASSES = YES
58 EXTRACT_LOCAL_METHODS = NO
59 HIDE_UNDOC_MEMBERS = NO
60 HIDE_UNDOC_CLASSES = NO
61 HIDE_FRIEND_COMPOUNDS = NO
62 HIDE_IN_BODY_DOCS = YES
64 CASE_SENSE_NAMES = YES
66 SHOW_INCLUDE_FILES = YES
68 SORT_MEMBER_DOCS = YES
70 SORT_BY_SCOPE_NAME = NO
71 GENERATE_TODOLIST = YES
72 GENERATE_TESTLIST = YES
73 GENERATE_BUGLIST = YES
74 GENERATE_DEPRECATEDLIST= YES
76 MAX_INITIALIZER_LINES = 30
80 FILE_VERSION_FILTER = {{SVNSTAT}}
81 #---------------------------------------------------------------------------
82 # configuration options related to warning and progress messages
83 #---------------------------------------------------------------------------
86 WARN_IF_UNDOCUMENTED = YES
87 WARN_IF_DOC_ERROR = YES
89 WARN_FORMAT = "$file:$line: $text"
91 #---------------------------------------------------------------------------
92 # configuration options related to the input files
93 #---------------------------------------------------------------------------
137 EXCLUDE = {{EXCLUDE}}
138 EXCLUDE_SYMLINKS = YES
139 EXCLUDE_PATTERNS = LocalSettings.php AdminSettings.php StartProfiler.php .svn */.git/* {{EXCLUDE_PATTERNS}}
142 EXAMPLE_RECURSIVE = NO
146 FILTER_SOURCE_FILES = NO
147 #---------------------------------------------------------------------------
148 # configuration options related to source browsing
149 #---------------------------------------------------------------------------
152 STRIP_CODE_COMMENTS = YES
153 REFERENCED_BY_RELATION = YES
154 REFERENCES_RELATION = YES
156 VERBATIM_HEADERS = YES
157 #---------------------------------------------------------------------------
158 # configuration options related to the alphabetical class index
159 #---------------------------------------------------------------------------
160 ALPHABETICAL_INDEX = NO
161 COLS_IN_ALPHA_INDEX = 5
163 #---------------------------------------------------------------------------
164 # configuration options related to the HTML output
165 #---------------------------------------------------------------------------
168 HTML_FILE_EXTENSION = .html
172 HTML_ALIGN_MEMBERS = YES
173 GENERATE_HTMLHELP = NO
180 ENUM_VALUES_PER_LINE = 4
181 GENERATE_TREEVIEW = YES
183 #---------------------------------------------------------------------------
184 # configuration options related to the LaTeX output
185 #---------------------------------------------------------------------------
188 LATEX_CMD_NAME = latex
189 MAKEINDEX_CMD_NAME = makeindex
197 LATEX_HIDE_INDICES = NO
198 #---------------------------------------------------------------------------
199 # configuration options related to the RTF output
200 #---------------------------------------------------------------------------
205 RTF_STYLESHEET_FILE =
206 RTF_EXTENSIONS_FILE =
207 #---------------------------------------------------------------------------
208 # configuration options related to the man page output
209 #---------------------------------------------------------------------------
214 #---------------------------------------------------------------------------
215 # configuration options related to the XML output
216 #---------------------------------------------------------------------------
221 XML_PROGRAMLISTING = YES
222 #---------------------------------------------------------------------------
223 # configuration options for the AutoGen Definitions output
224 #---------------------------------------------------------------------------
225 GENERATE_AUTOGEN_DEF = NO
226 #---------------------------------------------------------------------------
227 # configuration options related to the Perl module output
228 #---------------------------------------------------------------------------
229 GENERATE_PERLMOD = NO
232 PERLMOD_MAKEVAR_PREFIX =
233 #---------------------------------------------------------------------------
234 # Configuration options related to the preprocessor
235 #---------------------------------------------------------------------------
236 ENABLE_PREPROCESSING = YES
238 EXPAND_ONLY_PREDEF = NO
239 SEARCH_INCLUDES = YES
241 INCLUDE_FILE_PATTERNS =
244 SKIP_FUNCTION_MACROS = YES
245 #---------------------------------------------------------------------------
246 # Configuration::additions related to external references
247 #---------------------------------------------------------------------------
249 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
251 EXTERNAL_GROUPS = YES
252 PERL_PATH = /usr/bin/perl
253 #---------------------------------------------------------------------------
254 # Configuration options related to the dot tool
255 #---------------------------------------------------------------------------
257 HIDE_UNDOC_RELATIONS = YES
258 HAVE_DOT = {{HAVE_DOT}}
260 COLLABORATION_GRAPH = YES
263 TEMPLATE_RELATIONS = NO
265 INCLUDED_BY_GRAPH = YES
268 GRAPHICAL_HIERARCHY = YES
269 DIRECTORY_GRAPH = YES
270 DOT_IMAGE_FORMAT = png
273 MAX_DOT_GRAPH_DEPTH = 1000
275 DOT_MULTI_TARGETS = NO
276 GENERATE_LEGEND = YES
278 #---------------------------------------------------------------------------
279 # Configuration::additions related to the search engine
280 #---------------------------------------------------------------------------
283 ALIASES = "type{1}=<b> \1 </b>:" \
284 "types{2}=<b> \1 </b> or <b> \2 </b>:" \
285 "types{3}=<b> \1 </b>, <b> \2 </b>, or <b> \3 </b>:" \
286 "arrayof{2}=<b> Array </b> of \2" \
288 "boolean=\type{Boolean}" \
289 "bool=\type{Boolean}" \
290 "integer=\type{Integer}" \
291 "int=\type{Integer}" \
292 "string=\type{String}" \
293 "str=\type{String}" \
294 "mixed=\type{Mixed}" \
295 "access=\par Access:\n" \
296 "private=\access private" \
297 "protected=\access protected" \
298 "public=\access public" \