]> git.saurik.com Git - wxWidgets.git/blob - docs/doxygen/Doxyfile_inc
substitute '@b NB:' with '@note'; first partial revision of e*h headers; replace...
[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 related configuration 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 = YES
21 ABBREVIATE_BRIEF =
22 ALWAYS_DETAILED_SEC = YES
23 INLINE_INHERITED_MEMB = NO
24 FULL_PATH_NAMES = NO
25 STRIP_FROM_PATH =
26 STRIP_FROM_INC_PATH =
27 SHORT_NAMES = NO
28 JAVADOC_AUTOBRIEF = NO
29 QT_AUTOBRIEF = NO
30 MULTILINE_CPP_IS_BRIEF = NO
31 DETAILS_AT_TOP = YES
32 INHERIT_DOCS = YES
33 SEPARATE_MEMBER_PAGES = NO
34 TAB_SIZE = 4
35 OPTIMIZE_OUTPUT_FOR_C = NO
36 OPTIMIZE_OUTPUT_JAVA = NO
37 BUILTIN_STL_SUPPORT = NO
38 CPP_CLI_SUPPORT = NO
39 DISTRIBUTE_GROUP_DOC = YES
40 SUBGROUPING = YES
41
42 #---------------------------------------------------------------------------
43 # Aliases
44 #---------------------------------------------------------------------------
45
46 # This is the most important part of the wxWidgets Doxyfile; aliases allow
47 # us to keep the headers readable and "implement" wxWidgets-specific commands.
48
49 # event aliases
50 ALIASES = beginEventTable{1}="\n<span class='events'>Events:</span><p>The following event handler macros redirect the events to member functions with a prototype: <span class='eventHandler'>void handler(\1& event)</span></p>"
51 ALIASES += event{1}="\li <span class='event'>\1</span>"
52 ALIASES += event{2}="\li <span class='event'>\1, \2</span>"
53 ALIASES += event{3}="\li <span class='event'>\1, \2, \3</span>"
54 ALIASES += event{4}="\li <span class='event'>\1, \2, \3, \4</span>"
55 ALIASES += endEventTable="\n"
56
57 # style aliases
58 ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span>"
59 ALIASES += style{1}="\li <span class='style'>\1</span>"
60 ALIASES += endStyleTable="\n"
61
62 # extra style aliases
63 ALIASES += beginExtraStyleTable="<div><span class='styles'>Extra styles:</span>"
64 ALIASES += endExtraStyleTable="</div>"
65
66 # aliases for additional wx-specific infos
67 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>"
68 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>"
69 ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
70 ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
71 ALIASES += stdobjects="<span class='stdobj'>Predefined objects:</span>"
72
73 # native implementation infos:
74 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>"
75 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>"
76 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>"
77 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>"
78
79 # onlyfor infos:
80 # NOTE: we need to be able to retrieve these infos also from the XML output, thus
81 # we use the \xmlonly and \endxmlonly commands to include custom XML tags
82 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"
83 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"
84 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"
85 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"
86
87 # creates appearance section: this should be used for all main GUI controls
88 ALIASES += appearance{1}="@htmlonly <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"
89
90 # IMPORTANT: the \headerfile command does not work everywhere we'd need it,
91 # e.g. in the constants page we need to specify an header file
92 # even if they're not inside a \class, \function or \struct command:
93 ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
94
95 # IMPORTANT: inside a \class, we want to specify the header file only once
96 # and not twice as the \headerfile command requires:
97 ALIASES += wxheader{1}="\headerfile \1 wx/\1"
98
99 # the following alias avoids to repeat lots of times the same statement:
100 ALIASES += wxsince{1}="\since This function is new since wxWidgets version \1."
101
102 # some formatting aliases
103 ALIASES += true="<span class='literal'>true</span>"
104 ALIASES += false="<span class='literal'>false</span>"
105 ALIASES += NULL="<span class='literal'>NULL</span>"
106
107 # NOTE: these are important as you can't write in the docs
108 # just #ifdef since the # character is used by Doxygen
109 # for explicit linking; use the following aliases instead!
110 # However to avoid overwriting e.g. \if Doxygen command the _
111 # character is postfixed
112 ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
113 ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
114 ALIASES += if_="<span class='literal'>\#if</span>"
115 ALIASES += endif_="<span class='literal'>\#endif</span>"
116
117 # table aliases for 2 and 3 column tables
118 ALIASES += beginTable="<center><table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
119 ALIASES += beginInvisibleTable="<center><table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
120 ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
121 ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
122 ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
123 ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
124 ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
125 ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
126 ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
127 ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
128 ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
129 ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
130 ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
131 ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
132 ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
133 ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
134 ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
135 ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
136 ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
137 ALIASES += endTable="</table></center>"
138
139 # definition list aliases
140 # a definition list currently is rendered as 2-column table but it may use as
141 # well the <dl>, <dt> and <dd> HTML tags in future.
142 # In any case a definition list differs from a table because of its semantic
143 # nature and because it is always the association of a "title" with a "description"
144 # (in contrast a table may have more than 2 columns of data)...
145 ALIASES += beginDefList="<table class='doclist'>"
146 ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
147 ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
148 ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
149 ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
150 ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
151 ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
152 ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
153 ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
154 ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
155 ALIASES += endDefList="</table>"
156
157 # See ENABLED_SECTIONS configuration key for more info about these:
158 ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL \n <b>wxPerl note</b>\n\n"
159 ALIASES += endWxPerlOnly="\endif"
160 ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL \n <b>wxPython note</b>\n\n"
161 ALIASES += endWxPythonOnly="\endif"
162
163 # This is to get around a bug in Doxygen that prevents use of '{' or '}'
164 # inside of any aliased command in parameters.
165 ALIASES += leftCurly="{"
166 ALIASES += rightCurly="}"
167
168
169 #---------------------------------------------------------------------------
170 # Build related configuration options
171 #---------------------------------------------------------------------------
172 EXTRACT_ALL = YES
173 EXTRACT_PRIVATE = NO
174 EXTRACT_STATIC = YES
175 EXTRACT_LOCAL_CLASSES = YES
176 EXTRACT_LOCAL_METHODS = NO
177 EXTRACT_ANON_NSPACES = YES
178 HIDE_UNDOC_MEMBERS = NO
179 HIDE_UNDOC_CLASSES = NO
180 HIDE_FRIEND_COMPOUNDS = NO
181 HIDE_IN_BODY_DOCS = NO
182 INTERNAL_DOCS = NO
183 CASE_SENSE_NAMES = NO
184 HIDE_SCOPE_NAMES = NO
185 SHOW_INCLUDE_FILES = YES
186 INLINE_INFO = YES
187 SORT_MEMBER_DOCS = YES
188 SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
189 SORT_BY_SCOPE_NAME = NO
190 GENERATE_TODOLIST = YES
191 GENERATE_TESTLIST = YES
192 GENERATE_BUGLIST = YES
193 GENERATE_DEPRECATEDLIST= YES
194
195 # can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
196 ENABLED_SECTIONS =
197
198 MAX_INITIALIZER_LINES = 30
199 SHOW_USED_FILES = YES
200 SHOW_DIRECTORIES = YES
201 FILE_VERSION_FILTER =
202
203 #---------------------------------------------------------------------------
204 # configuration options related to warning and progress messages
205 #---------------------------------------------------------------------------
206 QUIET = YES
207 WARNINGS = YES
208 WARN_IF_UNDOCUMENTED = YES
209 WARN_IF_DOC_ERROR = YES
210 WARN_NO_PARAMDOC = YES
211 WARN_FORMAT = "$file:$line: $text "
212 WARN_LOGFILE = doxygen.log
213
214 #---------------------------------------------------------------------------
215 # configuration options related to the input files
216 #---------------------------------------------------------------------------
217 INPUT = ./mainpages ./groups ./overviews ../../interface
218 INPUT_ENCODING = UTF-8
219 FILE_PATTERNS = *.h *.txt
220 RECURSIVE = YES
221 EXCLUDE =
222 EXCLUDE_SYMLINKS = NO
223 EXCLUDE_PATTERNS =
224 EXCLUDE_SYMBOLS =
225 EXAMPLE_PATH =
226 EXAMPLE_PATTERNS = *
227 EXAMPLE_RECURSIVE = YES
228 IMAGE_PATH = images
229 INPUT_FILTER =
230 FILTER_PATTERNS =
231 FILTER_SOURCE_FILES = NO
232
233 #---------------------------------------------------------------------------
234 # configuration options related to source browsing
235 #---------------------------------------------------------------------------
236 SOURCE_BROWSER = NO
237 INLINE_SOURCES = NO
238 STRIP_CODE_COMMENTS = YES
239 REFERENCED_BY_RELATION = NO
240 REFERENCES_RELATION = NO
241 REFERENCES_LINK_SOURCE = YES
242 USE_HTAGS = NO
243 VERBATIM_HEADERS = NO
244
245 #---------------------------------------------------------------------------
246 # configuration options related to the alphabetical class index
247 #---------------------------------------------------------------------------
248 ALPHABETICAL_INDEX = YES
249 COLS_IN_ALPHA_INDEX = 5
250 IGNORE_PREFIX = wx
251
252 #---------------------------------------------------------------------------
253 # configuration options related to the HTML output
254 #---------------------------------------------------------------------------
255 GENERATE_HTML = NO # Only change in format output configs
256 HTML_OUTPUT = html
257 HTML_FILE_EXTENSION = .html
258 HTML_HEADER = htmlheader.inc
259 HTML_FOOTER = htmlfooter.inc
260 HTML_STYLESHEET =
261 HTML_ALIGN_MEMBERS = YES
262 GENERATE_HTMLHELP = NO # Only change in format output configs
263 HTML_DYNAMIC_SECTIONS = YES
264 CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
265 HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
266 GENERATE_CHI = NO
267 BINARY_TOC = NO
268 TOC_EXPAND = NO
269 DISABLE_INDEX = NO
270 ENUM_VALUES_PER_LINE = 4
271 GENERATE_TREEVIEW = NO
272 TREEVIEW_WIDTH = 250
273
274 #---------------------------------------------------------------------------
275 # configuration options related to the LaTeX output
276 #---------------------------------------------------------------------------
277 GENERATE_LATEX = NO # Only change in format output configs
278 LATEX_OUTPUT = latex
279 LATEX_CMD_NAME = latex
280 MAKEINDEX_CMD_NAME = makeindex
281 COMPACT_LATEX = NO
282 PAPER_TYPE = a4wide
283 EXTRA_PACKAGES =
284 LATEX_HEADER = latexdocstart.inc
285 PDF_HYPERLINKS = YES
286 USE_PDFLATEX = YES
287 LATEX_BATCHMODE = YES
288 LATEX_HIDE_INDICES = NO
289
290 #---------------------------------------------------------------------------
291 # configuration options related to the RTF output
292 #---------------------------------------------------------------------------
293 GENERATE_RTF = NO # Only change in format output configs
294 RTF_OUTPUT = rtf
295 COMPACT_RTF = NO
296 RTF_HYPERLINKS = NO
297 RTF_STYLESHEET_FILE =
298 RTF_EXTENSIONS_FILE =
299
300 #---------------------------------------------------------------------------
301 # configuration options related to the man page output
302 #---------------------------------------------------------------------------
303 GENERATE_MAN = NO # Only change in format output configs
304 MAN_OUTPUT = man
305 MAN_EXTENSION = .3
306 MAN_LINKS = NO
307
308 #---------------------------------------------------------------------------
309 # configuration options related to the XML output
310 #---------------------------------------------------------------------------
311 GENERATE_XML = NO # Only change in format output configs
312 XML_OUTPUT = xml
313 XML_SCHEMA =
314 XML_DTD =
315 XML_PROGRAMLISTING = YES
316
317 #---------------------------------------------------------------------------
318 # configuration options for the AutoGen Definitions output
319 #---------------------------------------------------------------------------
320 GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
321
322 #---------------------------------------------------------------------------
323 # configuration options related to the Perl module output
324 #---------------------------------------------------------------------------
325 GENERATE_PERLMOD = NO # Only change in format output configs
326 PERLMOD_LATEX = YES
327 PERLMOD_PRETTY = YES
328 PERLMOD_MAKEVAR_PREFIX =
329
330 #---------------------------------------------------------------------------
331 # Configuration options related to the preprocessor
332 #---------------------------------------------------------------------------
333 ENABLE_PREPROCESSING = YES
334 MACRO_EXPANSION = NO
335 EXPAND_ONLY_PREDEF = NO
336 SEARCH_INCLUDES = YES
337 INCLUDE_PATH =
338 INCLUDE_FILE_PATTERNS =
339 PREDEFINED =
340 EXPAND_AS_DEFINED =
341 SKIP_FUNCTION_MACROS = YES
342
343 #---------------------------------------------------------------------------
344 # Configuration::additions related to external references
345 #---------------------------------------------------------------------------
346 TAGFILES =
347 GENERATE_TAGFILE =
348 ALLEXTERNALS = NO
349 EXTERNAL_GROUPS = YES
350 PERL_PATH = /usr/bin/perl
351
352 #---------------------------------------------------------------------------
353 # Configuration options related to the dot tool
354 #---------------------------------------------------------------------------
355 CLASS_DIAGRAMS = YES
356 MSCGEN_PATH =
357 HIDE_UNDOC_RELATIONS = YES
358 HAVE_DOT = YES
359 CLASS_GRAPH = NO
360 COLLABORATION_GRAPH = NO
361 GROUP_GRAPHS = NO
362 UML_LOOK = NO
363 TEMPLATE_RELATIONS = NO
364 INCLUDE_GRAPH = NO
365 INCLUDED_BY_GRAPH = NO
366 CALL_GRAPH = NO
367 CALLER_GRAPH = NO
368 GRAPHICAL_HIERARCHY = NO
369 DIRECTORY_GRAPH = NO
370 DOT_IMAGE_FORMAT = png
371 DOT_PATH =
372 DOTFILE_DIRS =
373 DOT_GRAPH_MAX_NODES = 50
374 MAX_DOT_GRAPH_DEPTH = 1000
375 DOT_TRANSPARENT = NO
376 DOT_MULTI_TARGETS = NO
377 GENERATE_LEGEND = YES
378 DOT_CLEANUP = YES
379
380 #---------------------------------------------------------------------------
381 # Configuration::additions related to the search engine
382 #---------------------------------------------------------------------------
383 SEARCHENGINE = NO
384