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 "codingStandardsIgnoreEnd=" \
61 "codingStandardsIgnoreStart=" \
64 "expectedException=" \
65 "expectedExceptionMessage=" \
70 OPTIMIZE_OUTPUT_FOR_C = NO
71 OPTIMIZE_OUTPUT_JAVA = NO
72 OPTIMIZE_FOR_FORTRAN = NO
73 OPTIMIZE_OUTPUT_VHDL = NO
75 MARKDOWN_SUPPORT = YES
76 AUTOLINK_SUPPORT = YES
77 BUILTIN_STL_SUPPORT = NO
80 IDL_PROPERTY_SUPPORT = YES
81 DISTRIBUTE_GROUP_DOC = YES
83 INLINE_GROUPED_CLASSES = NO
84 INLINE_SIMPLE_STRUCTS = NO
85 TYPEDEF_HIDES_STRUCT = NO
87 #---------------------------------------------------------------------------
88 # Build related configuration options
89 #---------------------------------------------------------------------------
94 EXTRACT_LOCAL_CLASSES = YES
95 EXTRACT_LOCAL_METHODS = NO
96 EXTRACT_ANON_NSPACES = NO
97 HIDE_UNDOC_MEMBERS = NO
98 HIDE_UNDOC_CLASSES = NO
99 HIDE_FRIEND_COMPOUNDS = NO
100 HIDE_IN_BODY_DOCS = YES
102 CASE_SENSE_NAMES = YES
103 HIDE_SCOPE_NAMES = NO
104 SHOW_INCLUDE_FILES = YES
105 SHOW_GROUPED_MEMB_INC = NO
106 FORCE_LOCAL_INCLUDES = NO
108 SORT_MEMBER_DOCS = YES
109 SORT_BRIEF_DOCS = YES
110 SORT_MEMBERS_CTORS_1ST = NO
111 SORT_GROUP_NAMES = NO
112 SORT_BY_SCOPE_NAME = NO
113 STRICT_PROTO_MATCHING = NO
114 GENERATE_TODOLIST = YES
115 GENERATE_TESTLIST = YES
116 GENERATE_BUGLIST = YES
117 GENERATE_DEPRECATEDLIST= YES
119 MAX_INITIALIZER_LINES = 30
120 SHOW_USED_FILES = YES
123 FILE_VERSION_FILTER =
126 #---------------------------------------------------------------------------
127 # Configuration options related to warning and progress messages
128 #---------------------------------------------------------------------------
131 WARN_IF_UNDOCUMENTED = YES
132 WARN_IF_DOC_ERROR = YES
133 WARN_NO_PARAMDOC = NO
134 WARN_FORMAT = "$file:$line: $text"
136 #---------------------------------------------------------------------------
137 # Configuration options related to the input files
138 #---------------------------------------------------------------------------
140 INPUT_ENCODING = UTF-8
141 FILE_PATTERNS = *.php \
145 EXCLUDE = {{EXCLUDE}}
146 EXCLUDE_SYMLINKS = YES
147 EXCLUDE_PATTERNS = LocalSettings.php \
155 EXAMPLE_RECURSIVE = NO
157 INPUT_FILTER = "{{INPUT_FILTER}}"
159 FILTER_SOURCE_FILES = NO
160 FILTER_SOURCE_PATTERNS =
161 USE_MDFILE_AS_MAINPAGE =
162 #---------------------------------------------------------------------------
163 # Configuration options related to source browsing
164 #---------------------------------------------------------------------------
167 STRIP_CODE_COMMENTS = YES
168 REFERENCED_BY_RELATION = YES
169 REFERENCES_RELATION = YES
170 REFERENCES_LINK_SOURCE = YES
171 SOURCE_TOOLTIPS = YES
173 VERBATIM_HEADERS = YES
174 #---------------------------------------------------------------------------
175 # Configuration options related to the alphabetical class index
176 #---------------------------------------------------------------------------
177 ALPHABETICAL_INDEX = NO
178 COLS_IN_ALPHA_INDEX = 5
180 #---------------------------------------------------------------------------
181 # Configuration options related to the HTML output
182 #---------------------------------------------------------------------------
185 HTML_FILE_EXTENSION = .html
189 HTML_EXTRA_STYLESHEET =
191 HTML_COLORSTYLE_HUE = 220
192 HTML_COLORSTYLE_SAT = 100
193 HTML_COLORSTYLE_GAMMA = 80
195 HTML_DYNAMIC_SECTIONS = NO
196 HTML_INDEX_NUM_ENTRIES = 100
198 DOCSET_FEEDNAME = "Doxygen generated docs"
199 DOCSET_BUNDLE_ID = org.doxygen.Project
200 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
201 DOCSET_PUBLISHER_NAME = Publisher
202 GENERATE_HTMLHELP = NO
211 QHP_NAMESPACE = org.doxygen.Project
212 QHP_VIRTUAL_FOLDER = doc
213 QHP_CUST_FILTER_NAME =
214 QHP_CUST_FILTER_ATTRS =
215 QHP_SECT_FILTER_ATTRS =
217 GENERATE_ECLIPSEHELP = NO
218 ECLIPSE_DOC_ID = org.doxygen.Project
220 GENERATE_TREEVIEW = YES
221 ENUM_VALUES_PER_LINE = 4
223 EXT_LINKS_IN_WINDOW = NO
224 FORMULA_FONTSIZE = 10
225 FORMULA_TRANSPARENT = YES
227 MATHJAX_FORMAT = HTML-CSS
228 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
232 SERVER_BASED_SEARCH = YES
235 SEARCHDATA_FILE = searchdata.xml
237 EXTRA_SEARCH_MAPPINGS =
238 #---------------------------------------------------------------------------
239 # Configuration options related to the preprocessor
240 #---------------------------------------------------------------------------
241 ENABLE_PREPROCESSING = YES
243 EXPAND_ONLY_PREDEF = NO
244 SEARCH_INCLUDES = YES
246 INCLUDE_FILE_PATTERNS =
249 SKIP_FUNCTION_MACROS = YES
250 #---------------------------------------------------------------------------
251 # Configuration options related to external references
252 #---------------------------------------------------------------------------
254 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
256 EXTERNAL_GROUPS = YES
258 #---------------------------------------------------------------------------
259 # Configuration options related to the dot tool
260 #---------------------------------------------------------------------------
264 HIDE_UNDOC_RELATIONS = YES
265 HAVE_DOT = {{HAVE_DOT}}
267 DOT_FONTNAME = Helvetica
271 COLLABORATION_GRAPH = YES
274 UML_LIMIT_NUM_FIELDS = 10
275 TEMPLATE_RELATIONS = NO
277 INCLUDED_BY_GRAPH = YES
280 GRAPHICAL_HIERARCHY = YES
281 DIRECTORY_GRAPH = YES
282 DOT_IMAGE_FORMAT = png
288 DOT_GRAPH_MAX_NODES = 50
289 MAX_DOT_GRAPH_DEPTH = 1000
291 DOT_MULTI_TARGETS = YES
292 GENERATE_LEGEND = YES