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=" \
65 OPTIMIZE_OUTPUT_FOR_C = NO
66 OPTIMIZE_OUTPUT_JAVA = NO
67 OPTIMIZE_FOR_FORTRAN = NO
68 OPTIMIZE_OUTPUT_VHDL = NO
70 MARKDOWN_SUPPORT = YES
71 AUTOLINK_SUPPORT = YES
72 BUILTIN_STL_SUPPORT = NO
75 IDL_PROPERTY_SUPPORT = YES
76 DISTRIBUTE_GROUP_DOC = YES
78 INLINE_GROUPED_CLASSES = NO
79 INLINE_SIMPLE_STRUCTS = NO
80 TYPEDEF_HIDES_STRUCT = NO
82 #---------------------------------------------------------------------------
83 # Build related configuration options
84 #---------------------------------------------------------------------------
89 EXTRACT_LOCAL_CLASSES = YES
90 EXTRACT_LOCAL_METHODS = NO
91 EXTRACT_ANON_NSPACES = NO
92 HIDE_UNDOC_MEMBERS = NO
93 HIDE_UNDOC_CLASSES = NO
94 HIDE_FRIEND_COMPOUNDS = NO
95 HIDE_IN_BODY_DOCS = YES
97 CASE_SENSE_NAMES = YES
99 SHOW_INCLUDE_FILES = YES
100 SHOW_GROUPED_MEMB_INC = NO
101 FORCE_LOCAL_INCLUDES = NO
103 SORT_MEMBER_DOCS = YES
104 SORT_BRIEF_DOCS = YES
105 SORT_MEMBERS_CTORS_1ST = NO
106 SORT_GROUP_NAMES = NO
107 SORT_BY_SCOPE_NAME = NO
108 STRICT_PROTO_MATCHING = NO
109 GENERATE_TODOLIST = YES
110 GENERATE_TESTLIST = NO
111 GENERATE_BUGLIST = NO
112 GENERATE_DEPRECATEDLIST= YES
114 MAX_INITIALIZER_LINES = 30
115 SHOW_USED_FILES = YES
118 FILE_VERSION_FILTER =
121 #---------------------------------------------------------------------------
122 # Configuration options related to warning and progress messages
123 #---------------------------------------------------------------------------
126 WARN_IF_UNDOCUMENTED = YES
127 WARN_IF_DOC_ERROR = YES
128 WARN_NO_PARAMDOC = NO
129 WARN_FORMAT = "$file:$line: $text"
131 #---------------------------------------------------------------------------
132 # Configuration options related to the input files
133 #---------------------------------------------------------------------------
135 INPUT_ENCODING = UTF-8
136 FILE_PATTERNS = *.php \
140 EXCLUDE = {{EXCLUDE}}
141 EXCLUDE_SYMLINKS = YES
142 EXCLUDE_PATTERNS = LocalSettings.php \
151 EXAMPLE_RECURSIVE = NO
153 INPUT_FILTER = "{{INPUT_FILTER}}"
155 FILTER_SOURCE_FILES = NO
156 FILTER_SOURCE_PATTERNS =
157 USE_MDFILE_AS_MAINPAGE =
158 #---------------------------------------------------------------------------
159 # Configuration options related to source browsing
160 #---------------------------------------------------------------------------
163 STRIP_CODE_COMMENTS = YES
164 REFERENCED_BY_RELATION = YES
165 REFERENCES_RELATION = YES
166 REFERENCES_LINK_SOURCE = YES
167 SOURCE_TOOLTIPS = YES
169 VERBATIM_HEADERS = YES
170 #---------------------------------------------------------------------------
171 # Configuration options related to the alphabetical class index
172 #---------------------------------------------------------------------------
173 ALPHABETICAL_INDEX = NO
174 COLS_IN_ALPHA_INDEX = 5
176 #---------------------------------------------------------------------------
177 # Configuration options related to the HTML output
178 #---------------------------------------------------------------------------
181 HTML_FILE_EXTENSION = .html
185 HTML_EXTRA_STYLESHEET =
187 HTML_COLORSTYLE_HUE = 220
188 HTML_COLORSTYLE_SAT = 100
189 HTML_COLORSTYLE_GAMMA = 80
191 HTML_DYNAMIC_SECTIONS = NO
192 HTML_INDEX_NUM_ENTRIES = 100
194 DOCSET_FEEDNAME = "Doxygen generated docs"
195 DOCSET_BUNDLE_ID = org.doxygen.Project
196 DOCSET_PUBLISHER_ID = org.doxygen.Publisher
197 DOCSET_PUBLISHER_NAME = Publisher
198 GENERATE_HTMLHELP = NO
207 QHP_NAMESPACE = org.doxygen.Project
208 QHP_VIRTUAL_FOLDER = doc
209 QHP_CUST_FILTER_NAME =
210 QHP_CUST_FILTER_ATTRS =
211 QHP_SECT_FILTER_ATTRS =
213 GENERATE_ECLIPSEHELP = NO
214 ECLIPSE_DOC_ID = org.doxygen.Project
216 GENERATE_TREEVIEW = YES
217 ENUM_VALUES_PER_LINE = 4
219 EXT_LINKS_IN_WINDOW = NO
220 FORMULA_FONTSIZE = 10
221 FORMULA_TRANSPARENT = YES
223 MATHJAX_FORMAT = HTML-CSS
224 MATHJAX_RELPATH = http://www.mathjax.org/mathjax
228 SERVER_BASED_SEARCH = YES
231 SEARCHDATA_FILE = searchdata.xml
233 EXTRA_SEARCH_MAPPINGS =
234 #---------------------------------------------------------------------------
235 # Configuration options related to the preprocessor
236 #---------------------------------------------------------------------------
237 ENABLE_PREPROCESSING = YES
239 EXPAND_ONLY_PREDEF = NO
240 SEARCH_INCLUDES = YES
242 INCLUDE_FILE_PATTERNS =
245 SKIP_FUNCTION_MACROS = YES
246 #---------------------------------------------------------------------------
247 # Configuration options related to external references
248 #---------------------------------------------------------------------------
250 GENERATE_TAGFILE = {{OUTPUT_DIRECTORY}}/html/tagfile.xml
252 EXTERNAL_GROUPS = YES
254 #---------------------------------------------------------------------------
255 # Configuration options related to the dot tool
256 #---------------------------------------------------------------------------
260 HIDE_UNDOC_RELATIONS = YES
261 HAVE_DOT = {{HAVE_DOT}}
263 DOT_FONTNAME = Helvetica
267 COLLABORATION_GRAPH = YES
270 UML_LIMIT_NUM_FIELDS = 10
271 TEMPLATE_RELATIONS = NO
273 INCLUDED_BY_GRAPH = YES
276 GRAPHICAL_HIERARCHY = YES
277 DIRECTORY_GRAPH = YES
278 DOT_IMAGE_FORMAT = png
284 DOT_GRAPH_MAX_NODES = 50
285 MAX_DOT_GRAPH_DEPTH = 1000
287 DOT_MULTI_TARGETS = YES
288 GENERATE_LEGEND = YES