]> git.saurik.com Git - wxWidgets.git/blob - docs/doxygen/Doxyfile_inc
don't set SHOW_FILES, its value is yes by default anyhow and using it provokes a...
[wxWidgets.git] / docs / doxygen / Doxyfile_inc
1 #############################################################################
2 ## Name: Doxyfile_inc
3 ## Purpose: Main configuration file for the wxWidgets manual
4 ## Author: Francesco Montorsi
5 ## RCS-ID: $Id$
6 ## Licence: wxWindows license
7 #############################################################################
8
9 #---------------------------------------------------------------------------
10 # Project Options
11 #---------------------------------------------------------------------------
12
13 DOXYFILE_ENCODING = UTF-8
14 PROJECT_NAME = wxWidgets
15 PROJECT_NUMBER = 2.9.0
16 OUTPUT_DIRECTORY = out
17 CREATE_SUBDIRS = NO
18 OUTPUT_LANGUAGE = English
19 BRIEF_MEMBER_DESC = YES
20 REPEAT_BRIEF = NO
21 ABBREVIATE_BRIEF =
22 ALWAYS_DETAILED_SEC = YES
23 INLINE_INHERITED_MEMB = NO
24 FULL_PATH_NAMES = YES
25 STRIP_FROM_PATH = "$(WXWIDGETS)/"
26 STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
27 "$(WXWIDGETS)/interface/"
28 SHORT_NAMES = NO
29 JAVADOC_AUTOBRIEF = NO
30 QT_AUTOBRIEF = NO
31 MULTILINE_CPP_IS_BRIEF = NO
32 DETAILS_AT_TOP = YES
33 INHERIT_DOCS = YES
34 SEPARATE_MEMBER_PAGES = NO
35 TAB_SIZE = 4
36 OPTIMIZE_OUTPUT_FOR_C = NO
37 OPTIMIZE_OUTPUT_JAVA = NO
38 BUILTIN_STL_SUPPORT = NO
39 CPP_CLI_SUPPORT = NO
40 DISTRIBUTE_GROUP_DOC = YES
41 SUBGROUPING = YES
42
43 #---------------------------------------------------------------------------
44 # Aliases
45 #---------------------------------------------------------------------------
46
47 # This is the most important part of the wxWidgets Doxyfile; aliases allow
48 # us to keep the headers readable and "implement" wxWidgets-specific commands.
49
50 # event aliases
51 ALIASES = beginEventTable{1}="\n<span class='events'>Events:</span><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p><br>Event macros:<div>"
52 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
53 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
54 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
55 ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
56 ALIASES += endEventTable="</div>\n"
57
58 # style aliases
59 ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
60 ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
61 ALIASES += endStyleTable="</div>\n"
62
63 # extra style aliases
64 ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
65 ALIASES += endExtraStyleTable="</div>\n"
66
67 # flag aliases
68 ALIASES += beginFlagTable="<div>"
69 ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
70 ALIASES += endFlagTable="</div>\n"
71
72 # aliases for additional wx-specific infos
73 ALIASES += category{1}="\ingroup group_class_\1 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1</span></div>"
74 ALIASES += category{2}="\ingroup group_class_\1 group_class_\2 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2</span></div>"
75 ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
76 ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
77 ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
78
79 # native implementation infos:
80 ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
81 ALIASES += nativeimpl{2}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2 ports; a generic implementation is used elsewhere.</div>"
82 ALIASES += nativeimpl{3}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports; a generic implementation is used elsewhere.</div>"
83 ALIASES += nativeimpl{4}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports; a generic implementation is used elsewhere.</div>"
84
85 # onlyfor infos:
86 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
87 # we use the \xmlonly and \endxmlonly commands to include custom XML tags
88 ALIASES += onlyfor{1}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1 port.</div> \xmlonly <onlyfor>\1</onlyfor> \endxmlonly"
89 ALIASES += onlyfor{2}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2 ports.</div> \xmlonly <onlyfor>\1,\2</onlyfor> \endxmlonly"
90 ALIASES += onlyfor{3}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3 ports.</div> \xmlonly <onlyfor>\1,\2,\3</onlyfor> \endxmlonly"
91 ALIASES += onlyfor{4}="<div><span class='avail'>Availability:</span>&nbsp;&nbsp;only available for the \ref page_port_\1, \ref page_port_\2, \ref page_port_\3, \ref page_port_\4 ports.</div> \xmlonly <onlyfor>\1,\2,\3,\4</onlyfor> \endxmlonly"
92
93 # creates appearance section: this should be used for all main GUI controls
94 ALIASES += appearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='wxmsw/\1' alt='wxMSW appearance' class='appearance'></td><td><img src='wxgtk/\1' alt='wxGTK appearance' class='appearance'></td><td><img src='wxmac/\1' alt='wxMac appearance' class='appearance'></td></tr><tr><td>wxMSW appearance</td><td>wxGTK appearance</td><td>wxMac appearance</td></tr></table></div> \endhtmlonly"
95
96 # Use this in grouped global functions, and macros since they
97 # wouldn't otherwise indicate what header they are defined in.
98 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
99
100 # some formatting aliases
101 ALIASES += true="<span class='literal'>true</span>"
102 ALIASES += false="<span class='literal'>false</span>"
103 ALIASES += NULL="<span class='literal'>NULL</span>"
104
105 # NOTE: these are important as you can't write in the docs
106 # just #ifdef since the # character is used by Doxygen
107 # for explicit linking; use the following aliases instead!
108 # However to avoid overwriting e.g. \if Doxygen command the _
109 # character is postfixed
110 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
111 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
112 ALIASES += if_="<span class='literal'>\#if</span>"
113 ALIASES += endif_="<span class='literal'>\#endif</span>"
114
115 # table aliases for 2 and 3 column tables
116 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
117 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
118 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
119 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
120 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
121 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
122 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
123 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
124 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
125 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
126 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
127 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
128 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
129 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
130 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
131 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
132 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
133 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
134 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
135 ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
136 ALIASES += endTable="</table></center>"
137
138 # definition list aliases
139 # a definition list currently is rendered as 2-column table but it may use as
140 # well the <dl>, <dt> and <dd> HTML tags in future.
141 # In any case a definition list differs from a table because of its semantic
142 # nature and because it is always the association of a "title" with a "description"
143 # (in contrast a table may have more than 2 columns of data)...
144 ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
145 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
146 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
147 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
148 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
149 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
150 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
151 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
152 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
153 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
154 ALIASES += endDefList="</table>"
155
156 # See ENABLED_SECTIONS configuration key for more info about these:
157 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
158 ALIASES += endWxPerlOnly="\endif"
159 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
160 ALIASES += endWxPythonOnly="\endif"
161
162 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
163 # inside of any aliased command in parameters.
164 ALIASES += leftCurly="{"
165 ALIASES += rightCurly="}"
166
167 # Sample documentation related aliases
168 # For indicating the a directory containing a sample
169 ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
170 # For refering to the corresponding sample in a class document or a overview
171 # Usually placed in the queue of @see
172 ALIASES += sample{1}="\ref page_samples_\1"
173 # For generating a general description for a sample
174 # \1 could be a class or an overview or a descriptive sentence
175 # Shall be replaced by manual written description soon
176 ALIASES += sampleabout{1}="This sample demonstrates \1."
177 # For indicating the necessary condition of a sample or a class
178 # \1 is the wxUSE_XXX macro
179 ALIASES += buildwith{1}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
180 ALIASES += buildwith{2}="<b>Build Note:</b> You may need to build the wxWidgets library with <tt>\1</tt> and <tt>\2</tt> being set to 1 to be able to make it work, please read comments in @c <wx/setup_inc.h> for more info."
181
182 #---------------------------------------------------------------------------
183 # Build Options
184 #---------------------------------------------------------------------------
185
186 EXTRACT_ALL = YES
187 EXTRACT_PRIVATE = NO
188 EXTRACT_STATIC = YES
189 EXTRACT_LOCAL_CLASSES = YES
190 EXTRACT_LOCAL_METHODS = NO
191 EXTRACT_ANON_NSPACES = YES
192 HIDE_UNDOC_MEMBERS = NO
193 HIDE_UNDOC_CLASSES = NO
194 HIDE_FRIEND_COMPOUNDS = NO
195 HIDE_IN_BODY_DOCS = NO
196 INTERNAL_DOCS = NO
197 CASE_SENSE_NAMES = NO
198 HIDE_SCOPE_NAMES = NO
199 SHOW_INCLUDE_FILES = YES
200 INLINE_INFO = YES
201 SORT_MEMBER_DOCS = YES
202 SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
203 SORT_BY_SCOPE_NAME = NO
204 GENERATE_TODOLIST = YES
205 GENERATE_TESTLIST = YES
206 GENERATE_BUGLIST = YES
207 GENERATE_DEPRECATEDLIST= YES
208
209 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
210 ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
211
212 MAX_INITIALIZER_LINES = 30
213 SHOW_USED_FILES = NO
214 SHOW_DIRECTORIES = YES
215 #SHOW_FILES = YES # Doxygen 1.5.6+ only
216 FILE_VERSION_FILTER =
217
218 #---------------------------------------------------------------------------
219 # Warning and Progress Message Options
220 #---------------------------------------------------------------------------
221
222 QUIET = YES
223 WARNINGS = YES
224 WARN_IF_UNDOCUMENTED = YES
225 WARN_IF_DOC_ERROR = YES
226 WARN_NO_PARAMDOC = YES
227 WARN_FORMAT = "$file:$line: $text "
228 WARN_LOGFILE = doxygen.log
229
230 #---------------------------------------------------------------------------
231 # Input File Options
232 #---------------------------------------------------------------------------
233
234 INPUT = ./mainpages ./groups ./overviews ../../interface
235 INPUT_ENCODING = UTF-8
236 FILE_PATTERNS = *.h *.txt
237 RECURSIVE = YES
238 EXCLUDE =
239 EXCLUDE_SYMLINKS = NO
240 EXCLUDE_PATTERNS =
241 EXCLUDE_SYMBOLS =
242 EXAMPLE_PATH = ../
243 EXAMPLE_PATTERNS = *
244 EXAMPLE_RECURSIVE = NO
245 IMAGE_PATH = images
246 INPUT_FILTER =
247 FILTER_PATTERNS =
248 FILTER_SOURCE_FILES = NO
249
250 #---------------------------------------------------------------------------
251 # Source Browsing Options
252 #---------------------------------------------------------------------------
253
254 SOURCE_BROWSER = NO
255 INLINE_SOURCES = NO
256 STRIP_CODE_COMMENTS = YES
257 REFERENCED_BY_RELATION = NO
258 REFERENCES_RELATION = NO
259 REFERENCES_LINK_SOURCE = YES
260 USE_HTAGS = NO
261 VERBATIM_HEADERS = NO
262
263 #---------------------------------------------------------------------------
264 # Alphabetical Class Index Options
265 #---------------------------------------------------------------------------
266
267 ALPHABETICAL_INDEX = YES
268 COLS_IN_ALPHA_INDEX = 5
269 IGNORE_PREFIX = wx
270
271 #---------------------------------------------------------------------------
272 # configuration options related to the HTML output
273 #---------------------------------------------------------------------------
274 GENERATE_HTML = NO # Only change in format output configs
275 HTML_OUTPUT = html
276 HTML_FILE_EXTENSION = .html
277 HTML_HEADER = htmlheader.inc
278 HTML_FOOTER = htmlfooter.inc
279 HTML_STYLESHEET =
280 HTML_ALIGN_MEMBERS = YES
281 GENERATE_HTMLHELP = NO # Only change in format output configs
282 HTML_DYNAMIC_SECTIONS = YES
283 CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
284 HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
285 GENERATE_CHI = NO
286 BINARY_TOC = NO
287 TOC_EXPAND = NO
288 DISABLE_INDEX = NO
289 ENUM_VALUES_PER_LINE = 1
290 GENERATE_TREEVIEW = NO
291 TREEVIEW_WIDTH = 250
292
293 #---------------------------------------------------------------------------
294 # LaTeX Output Options
295 #---------------------------------------------------------------------------
296
297 GENERATE_LATEX = NO # Only change in format output configs
298 LATEX_OUTPUT = latex
299 LATEX_CMD_NAME = latex
300 MAKEINDEX_CMD_NAME = makeindex
301 COMPACT_LATEX = NO
302 PAPER_TYPE = a4wide
303 EXTRA_PACKAGES =
304 LATEX_HEADER = latexdocstart.inc
305 PDF_HYPERLINKS = YES
306 USE_PDFLATEX = YES
307 LATEX_BATCHMODE = YES
308 LATEX_HIDE_INDICES = NO
309
310 #---------------------------------------------------------------------------
311 # RTF Output Options
312 #---------------------------------------------------------------------------
313
314 GENERATE_RTF = NO # Only change in format output configs
315 RTF_OUTPUT = rtf
316 COMPACT_RTF = NO
317 RTF_HYPERLINKS = NO
318 RTF_STYLESHEET_FILE =
319 RTF_EXTENSIONS_FILE =
320
321 #---------------------------------------------------------------------------
322 # Man Page Output Options
323 #---------------------------------------------------------------------------
324
325 GENERATE_MAN = NO # Only change in format output configs
326 MAN_OUTPUT = man
327 MAN_EXTENSION = .3
328 MAN_LINKS = NO
329
330 #---------------------------------------------------------------------------
331 # XML Output Options
332 #---------------------------------------------------------------------------
333
334 GENERATE_XML = NO # Only change in format output configs
335 XML_OUTPUT = xml
336 XML_SCHEMA =
337 XML_DTD =
338 XML_PROGRAMLISTING = NO
339
340 #---------------------------------------------------------------------------
341 # AutoGen Definitions Output Options
342 #---------------------------------------------------------------------------
343
344 GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
345
346 #---------------------------------------------------------------------------
347 # Perl Module Output Options
348 #---------------------------------------------------------------------------
349
350 GENERATE_PERLMOD = NO # Only change in format output configs
351 PERLMOD_LATEX = YES
352 PERLMOD_PRETTY = YES
353 PERLMOD_MAKEVAR_PREFIX =
354
355 #---------------------------------------------------------------------------
356 # Preprocessor Options
357 #---------------------------------------------------------------------------
358
359 ENABLE_PREPROCESSING = YES
360 MACRO_EXPANSION = NO
361 EXPAND_ONLY_PREDEF = NO
362 SEARCH_INCLUDES = YES
363 INCLUDE_PATH =
364 INCLUDE_FILE_PATTERNS =
365 PREDEFINED =
366 EXPAND_AS_DEFINED =
367 SKIP_FUNCTION_MACROS = YES
368
369 #---------------------------------------------------------------------------
370 # Additions Related to External References
371 #---------------------------------------------------------------------------
372
373 TAGFILES =
374 GENERATE_TAGFILE =
375 ALLEXTERNALS = NO
376 EXTERNAL_GROUPS = YES
377 PERL_PATH = /usr/bin/perl
378
379 #---------------------------------------------------------------------------
380 # dot Tool Options
381 #---------------------------------------------------------------------------
382
383 CLASS_DIAGRAMS = YES
384 MSCGEN_PATH =
385 HIDE_UNDOC_RELATIONS = YES
386 HAVE_DOT = YES
387 CLASS_GRAPH = NO
388 COLLABORATION_GRAPH = NO
389 GROUP_GRAPHS = NO
390 UML_LOOK = NO
391 TEMPLATE_RELATIONS = NO
392 INCLUDE_GRAPH = NO
393 INCLUDED_BY_GRAPH = NO
394 CALL_GRAPH = NO
395 CALLER_GRAPH = NO
396 GRAPHICAL_HIERARCHY = NO
397 DIRECTORY_GRAPH = NO
398 DOT_IMAGE_FORMAT = png
399 DOT_PATH =
400 DOTFILE_DIRS =
401 DOT_GRAPH_MAX_NODES = 50
402 MAX_DOT_GRAPH_DEPTH = 1000
403 DOT_TRANSPARENT = NO
404 DOT_MULTI_TARGETS = NO
405 GENERATE_LEGEND = YES
406 DOT_CLEANUP = YES
407
408 #---------------------------------------------------------------------------
409 # Search Engine Options
410 #---------------------------------------------------------------------------
411
412 SEARCHENGINE = NO
413