* Format page protection warning identical to similar warnings
[mediawiki.git] / maintenance / Doxyfile
blobe221692acb3a95ac93f36462133ea4958e8b8ca9
1 # Doxyfile 1.5.6
4 # Some placeholders have been added for MediaWiki usage:
5 # {{OUTPUT_DIRECTORY}}
6 # {{CURRENT_VERSION}}
7 # {{STRIP_FROM_PATH}}
8 # {{SVNSTAT}}
9 # {{INPUT}}
11 # A number of MediaWiki-specific aliases are near the end of this file.
13 #---------------------------------------------------------------------------
14 # Project related configuration options
15 #---------------------------------------------------------------------------
16 PROJECT_NAME           = MediaWiki
17 PROJECT_NUMBER         = {{CURRENT_VERSION}}
18 OUTPUT_DIRECTORY       = {{OUTPUT_DIRECTORY}}
19 CREATE_SUBDIRS         = NO
20 OUTPUT_LANGUAGE        = English
21 BRIEF_MEMBER_DESC      = YES
22 REPEAT_BRIEF           = YES
23 ABBREVIATE_BRIEF       = "The $name class" \
24                          "The $name widget" \
25                          "The $name file" \
26                          is \
27                          provides \
28                          specifies \
29                          contains \
30                          represents \
31                          a \
32                          an \
33                          the
34 ALWAYS_DETAILED_SEC    = NO
35 INLINE_INHERITED_MEMB  = NO
36 FULL_PATH_NAMES        = YES
37 STRIP_FROM_PATH        = {{STRIP_FROM_PATH}}
38 STRIP_FROM_INC_PATH    = 
39 SHORT_NAMES            = NO
40 JAVADOC_AUTOBRIEF      = YES
41 MULTILINE_CPP_IS_BRIEF = NO
42 DETAILS_AT_TOP         = NO
43 INHERIT_DOCS           = YES
44 SEPARATE_MEMBER_PAGES  = NO
45 TAB_SIZE               = 8
46 ALIASES                = \
47         "type{1}=<b>\1</b>:" \
48         "twotypes{2}=<b>\1</b> or <b>\2</b>:" \
49         "threetypes{3}=<b>\1</b>, <b>\2</b>, or <b>\3</b>:" \
50         "arrayof{1}=<b>Array</b> of <b>\1</b>" \
51         "null=Null" \
52         "boolean=Boolean" \
53         "bool=\boolean" \
54         "integer=Integer" \
55         "int=\integer" \
56         "string=String" \
57         "str=\string" \
58         "array=Array" \
59         "mixed=Mixed"
60 OPTIMIZE_OUTPUT_FOR_C  = NO
61 OPTIMIZE_OUTPUT_JAVA   = NO
62 BUILTIN_STL_SUPPORT    = NO
63 DISTRIBUTE_GROUP_DOC   = YES
64 SUBGROUPING            = YES
65 #---------------------------------------------------------------------------
66 # Build related configuration options
67 #---------------------------------------------------------------------------
68 EXTRACT_ALL            = YES
69 EXTRACT_PRIVATE        = YES
70 EXTRACT_STATIC         = YES
71 EXTRACT_LOCAL_CLASSES  = YES
72 EXTRACT_LOCAL_METHODS  = NO
73 HIDE_UNDOC_MEMBERS     = NO
74 HIDE_UNDOC_CLASSES     = NO
75 HIDE_FRIEND_COMPOUNDS  = NO
76 HIDE_IN_BODY_DOCS      = YES
77 INTERNAL_DOCS          = NO
78 CASE_SENSE_NAMES       = YES
79 HIDE_SCOPE_NAMES       = NO
80 SHOW_INCLUDE_FILES     = YES
81 INLINE_INFO            = YES
82 SORT_MEMBER_DOCS       = YES
83 SORT_BRIEF_DOCS        = NO
84 SORT_BY_SCOPE_NAME     = NO
85 GENERATE_TODOLIST      = YES
86 GENERATE_TESTLIST      = YES
87 GENERATE_BUGLIST       = YES
88 GENERATE_DEPRECATEDLIST= YES
89 ENABLED_SECTIONS       = 
90 MAX_INITIALIZER_LINES  = 30
91 SHOW_USED_FILES        = YES
92 SHOW_DIRECTORIES       = NO
93 FILE_VERSION_FILTER    = {{SVNSTAT}}
94 #---------------------------------------------------------------------------
95 # configuration options related to warning and progress messages
96 #---------------------------------------------------------------------------
97 QUIET                  = NO
98 WARNINGS               = YES
99 WARN_IF_UNDOCUMENTED   = YES
100 WARN_IF_DOC_ERROR      = YES
101 WARN_NO_PARAMDOC       = NO
102 WARN_FORMAT            = "$file:$line: $text"
103 WARN_LOGFILE           = 
104 #---------------------------------------------------------------------------
105 # configuration options related to the input files
106 #---------------------------------------------------------------------------
107 INPUT                  = {{INPUT}}
108 FILE_PATTERNS          = *.c \
109                          *.cc \
110                          *.cxx \
111                          *.cpp \
112                          *.c++ \
113                          *.d \
114                          *.java \
115                          *.ii \
116                          *.ixx \
117                          *.ipp \
118                          *.i++ \
119                          *.inl \
120                          *.h \
121                          *.hh \
122                          *.hxx \
123                          *.hpp \
124                          *.h++ \
125                          *.idl \
126                          *.odl \
127                          *.cs \
128                          *.php \
129                          *.php3 \
130                          *.inc \
131                          *.m \
132                          *.mm \
133                          *.dox \
134                          *.py \
135                          *.C \
136                          *.CC \
137                          *.C++ \
138                          *.II \
139                          *.I++ \
140                          *.H \
141                          *.HH \
142                          *.H++ \
143                          *.CS \
144                          *.PHP \
145                          *.PHP3 \
146                          *.M \
147                          *.MM \
148                          *.PY
149 RECURSIVE              = YES
150 EXCLUDE                = 
151 EXCLUDE_SYMLINKS       = YES
152 EXCLUDE_PATTERNS       = LocalSettings.php AdminSettings.php
153 EXAMPLE_PATH           = 
154 EXAMPLE_PATTERNS       = *
155 EXAMPLE_RECURSIVE      = NO
156 IMAGE_PATH             = 
157 INPUT_FILTER           = 
158 FILTER_PATTERNS        = 
159 FILTER_SOURCE_FILES    = NO
160 #---------------------------------------------------------------------------
161 # configuration options related to source browsing
162 #---------------------------------------------------------------------------
163 SOURCE_BROWSER         = YES
164 INLINE_SOURCES         = NO
165 STRIP_CODE_COMMENTS    = YES
166 REFERENCED_BY_RELATION = YES
167 REFERENCES_RELATION    = YES
168 USE_HTAGS              = NO
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
175 IGNORE_PREFIX          = 
176 #---------------------------------------------------------------------------
177 # configuration options related to the HTML output
178 #---------------------------------------------------------------------------
179 GENERATE_HTML          = YES
180 HTML_OUTPUT            = html
181 HTML_FILE_EXTENSION    = .html
182 HTML_HEADER            = 
183 HTML_FOOTER            = 
184 HTML_STYLESHEET        = 
185 HTML_ALIGN_MEMBERS     = YES
186 GENERATE_HTMLHELP      = NO
187 CHM_FILE               = 
188 HHC_LOCATION           = 
189 GENERATE_CHI           = NO
190 BINARY_TOC             = NO
191 TOC_EXPAND             = YES
192 DISABLE_INDEX          = NO
193 ENUM_VALUES_PER_LINE   = 4
194 GENERATE_TREEVIEW      = YES
195 TREEVIEW_WIDTH         = 250
196 #---------------------------------------------------------------------------
197 # configuration options related to the LaTeX output
198 #---------------------------------------------------------------------------
199 GENERATE_LATEX         = NO
200 LATEX_OUTPUT           = latex
201 LATEX_CMD_NAME         = latex
202 MAKEINDEX_CMD_NAME     = makeindex
203 COMPACT_LATEX          = NO
204 PAPER_TYPE             = a4wide
205 EXTRA_PACKAGES         = 
206 LATEX_HEADER           = 
207 PDF_HYPERLINKS         = YES
208 USE_PDFLATEX           = YES
209 LATEX_BATCHMODE        = NO
210 LATEX_HIDE_INDICES     = NO
211 #---------------------------------------------------------------------------
212 # configuration options related to the RTF output
213 #---------------------------------------------------------------------------
214 GENERATE_RTF           = NO
215 RTF_OUTPUT             = rtf
216 COMPACT_RTF            = NO
217 RTF_HYPERLINKS         = NO
218 RTF_STYLESHEET_FILE    = 
219 RTF_EXTENSIONS_FILE    = 
220 #---------------------------------------------------------------------------
221 # configuration options related to the man page output
222 #---------------------------------------------------------------------------
223 GENERATE_MAN           = NO
224 MAN_OUTPUT             = man
225 MAN_EXTENSION          = .3
226 MAN_LINKS              = NO
227 #---------------------------------------------------------------------------
228 # configuration options related to the XML output
229 #---------------------------------------------------------------------------
230 GENERATE_XML           = NO
231 XML_OUTPUT             = xml
232 XML_SCHEMA             = 
233 XML_DTD                = 
234 XML_PROGRAMLISTING     = YES
235 #---------------------------------------------------------------------------
236 # configuration options for the AutoGen Definitions output
237 #---------------------------------------------------------------------------
238 GENERATE_AUTOGEN_DEF   = NO
239 #---------------------------------------------------------------------------
240 # configuration options related to the Perl module output
241 #---------------------------------------------------------------------------
242 GENERATE_PERLMOD       = NO
243 PERLMOD_LATEX          = NO
244 PERLMOD_PRETTY         = YES
245 PERLMOD_MAKEVAR_PREFIX = 
246 #---------------------------------------------------------------------------
247 # Configuration options related to the preprocessor   
248 #---------------------------------------------------------------------------
249 ENABLE_PREPROCESSING   = YES
250 MACRO_EXPANSION        = NO
251 EXPAND_ONLY_PREDEF     = NO
252 SEARCH_INCLUDES        = YES
253 INCLUDE_PATH           = 
254 INCLUDE_FILE_PATTERNS  = 
255 PREDEFINED             = 
256 EXPAND_AS_DEFINED      = 
257 SKIP_FUNCTION_MACROS   = YES
258 #---------------------------------------------------------------------------
259 # Configuration::additions related to external references   
260 #---------------------------------------------------------------------------
261 TAGFILES               = 
262 GENERATE_TAGFILE       = 
263 ALLEXTERNALS           = NO
264 EXTERNAL_GROUPS        = YES
265 PERL_PATH              = /usr/bin/perl
266 #---------------------------------------------------------------------------
267 # Configuration options related to the dot tool   
268 #---------------------------------------------------------------------------
269 CLASS_DIAGRAMS         = NO
270 HIDE_UNDOC_RELATIONS   = YES
271 HAVE_DOT               = NO
272 CLASS_GRAPH            = YES
273 COLLABORATION_GRAPH    = YES
274 GROUP_GRAPHS           = YES
275 UML_LOOK               = NO
276 TEMPLATE_RELATIONS     = NO
277 INCLUDE_GRAPH          = YES
278 INCLUDED_BY_GRAPH      = YES
279 CALL_GRAPH             = YES
280 GRAPHICAL_HIERARCHY    = YES
281 DIRECTORY_GRAPH        = YES
282 DOT_IMAGE_FORMAT       = png
283 DOT_PATH               = 
284 DOTFILE_DIRS           = 
285 MAX_DOT_GRAPH_DEPTH    = 1000
286 DOT_TRANSPARENT        = NO
287 DOT_MULTI_TARGETS      = NO
288 GENERATE_LEGEND        = YES
289 DOT_CLEANUP            = YES
290 #---------------------------------------------------------------------------
291 # Configuration::additions related to the search engine   
292 #---------------------------------------------------------------------------
293 SEARCHENGINE           = NO