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