]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/doxygen/Doxyfile_inc
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
if we keep autobrief comments = YES, let's repeat the brief comment in the detailed...
[wxWidgets.git] / docs / doxygen / Doxyfile_inc
... / ...
CommitLineData
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
13DOXYFILE_ENCODING = UTF-8
14PROJECT_NAME = wxWidgets
15PROJECT_NUMBER = 2.9.0
16OUTPUT_DIRECTORY = out
17CREATE_SUBDIRS = NO
18OUTPUT_LANGUAGE = English
19BRIEF_MEMBER_DESC = YES
20REPEAT_BRIEF = YES
21ABBREVIATE_BRIEF =
22ALWAYS_DETAILED_SEC = YES
23INLINE_INHERITED_MEMB = NO
24FULL_PATH_NAMES = YES
25STRIP_FROM_PATH = "$(WXWIDGETS)/"
26STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
27 "$(WXWIDGETS)/interface/"
28SHORT_NAMES = NO
29JAVADOC_AUTOBRIEF = YES
30QT_AUTOBRIEF = NO
31MULTILINE_CPP_IS_BRIEF = NO
32DETAILS_AT_TOP = YES
33INHERIT_DOCS = YES
34SEPARATE_MEMBER_PAGES = NO
35TAB_SIZE = 4
36OPTIMIZE_OUTPUT_FOR_C = NO
37OPTIMIZE_OUTPUT_JAVA = NO
38BUILTIN_STL_SUPPORT = NO
39CPP_CLI_SUPPORT = NO
40DISTRIBUTE_GROUP_DOC = YES
41SUBGROUPING = 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
51ALIASES = 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>"
52ALIASES += 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>"
53ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
54ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
55ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
56ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
57ALIASES += endEventTable="</div>\n"
58
59# style aliases
60ALIASES += beginStyleTable="\n<span class='styles'>Styles:</span><div>"
61ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
62ALIASES += endStyleTable="</div>\n"
63
64# extra style aliases
65ALIASES += beginExtraStyleTable="\n<span class='styles'>Extra styles:</span><div>"
66ALIASES += endExtraStyleTable="</div>\n"
67
68# flag aliases
69ALIASES += beginFlagTable="<div>"
70ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
71ALIASES += endFlagTable="</div>\n"
72
73# aliases for additional wx-specific infos
74ALIASES += 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>"
75ALIASES += 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>"
76ALIASES += library{1}="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
77ALIASES += nolibrary="<div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
78ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
79
80# native implementation infos:
81ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
82ALIASES += 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>"
83ALIASES += 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>"
84ALIASES += 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
89ALIASES += 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"
90ALIASES += 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"
91ALIASES += 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"
92ALIASES += 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
95ALIASES += 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.
99ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
100
101# some formatting aliases
102ALIASES += true="<span class='literal'>true</span>"
103ALIASES += false="<span class='literal'>false</span>"
104ALIASES += 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
111ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
112ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
113ALIASES += if_="<span class='literal'>\#if</span>"
114ALIASES += endif_="<span class='literal'>\#endif</span>"
115
116# table aliases for 2 and 3 column tables
117ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
118ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
119ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
120ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
121ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
122ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
123ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
124ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
125ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
126ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
127ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
128ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
129ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
130ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
131ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
132ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
133ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
134ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
135ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
136ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
137ALIASES += 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)...
145ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
146ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
147ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
148ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
149ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
150ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
151ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
152ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
153ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
154ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
155ALIASES += endDefList="</table>"
156ALIASES += 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:
159ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
160ALIASES += endWxPerlOnly="\endif"
161ALIASES += beginWxPythonOnly="\if WXPYTHON_MANUAL <b>wxPython Note:</b> "
162ALIASES += 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.
166ALIASES += leftCurly="{"
167ALIASES += rightCurly="}"
168
169# Sample documentation related aliases
170# For indicating the a directory containing a sample
171ALIASES += 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
174ALIASES += 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
178ALIASES += 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
181ALIASES += 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."
182ALIASES += 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
188EXTRACT_ALL = YES
189EXTRACT_PRIVATE = NO
190EXTRACT_STATIC = YES
191EXTRACT_LOCAL_CLASSES = YES
192EXTRACT_LOCAL_METHODS = NO
193EXTRACT_ANON_NSPACES = YES
194HIDE_UNDOC_MEMBERS = NO
195HIDE_UNDOC_CLASSES = NO
196HIDE_FRIEND_COMPOUNDS = NO
197HIDE_IN_BODY_DOCS = NO
198INTERNAL_DOCS = NO
199CASE_SENSE_NAMES = NO
200HIDE_SCOPE_NAMES = NO
201SHOW_INCLUDE_FILES = YES
202INLINE_INFO = YES
203SORT_MEMBER_DOCS = YES
204SORT_BRIEF_DOCS = NO # don't set it to YES! see http://bugzilla.gnome.org/show_bug.cgi?id=312655
205SORT_BY_SCOPE_NAME = NO
206GENERATE_TODOLIST = YES
207GENERATE_TESTLIST = YES
208GENERATE_BUGLIST = YES
209GENERATE_DEPRECATEDLIST= YES
210
211# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
212ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
213
214MAX_INITIALIZER_LINES = 30
215SHOW_USED_FILES = NO
216SHOW_DIRECTORIES = YES
217#SHOW_FILES = YES # Doxygen 1.5.6+ only
218FILE_VERSION_FILTER =
219
220#---------------------------------------------------------------------------
221# Warning and Progress Message Options
222#---------------------------------------------------------------------------
223
224QUIET = YES
225WARNINGS = YES
226WARN_IF_UNDOCUMENTED = YES
227WARN_IF_DOC_ERROR = YES
228WARN_NO_PARAMDOC = YES
229WARN_FORMAT = "$file:$line: $text "
230WARN_LOGFILE = doxygen.log
231
232#---------------------------------------------------------------------------
233# Input File Options
234#---------------------------------------------------------------------------
235
236INPUT = ./mainpages ./groups ./overviews ../../interface
237INPUT_ENCODING = UTF-8
238FILE_PATTERNS = *.h *.txt
239RECURSIVE = YES
240EXCLUDE =
241EXCLUDE_SYMLINKS = NO
242EXCLUDE_PATTERNS =
243EXCLUDE_SYMBOLS =
244EXAMPLE_PATH = ../
245EXAMPLE_PATTERNS = *
246EXAMPLE_RECURSIVE = NO
247IMAGE_PATH = images
248INPUT_FILTER =
249FILTER_PATTERNS =
250FILTER_SOURCE_FILES = NO
251
252#---------------------------------------------------------------------------
253# Source Browsing Options
254#---------------------------------------------------------------------------
255
256SOURCE_BROWSER = NO
257INLINE_SOURCES = NO
258STRIP_CODE_COMMENTS = YES
259REFERENCED_BY_RELATION = NO
260REFERENCES_RELATION = NO
261REFERENCES_LINK_SOURCE = YES
262USE_HTAGS = NO
263VERBATIM_HEADERS = NO
264
265#---------------------------------------------------------------------------
266# Alphabetical Class Index Options
267#---------------------------------------------------------------------------
268
269ALPHABETICAL_INDEX = YES
270COLS_IN_ALPHA_INDEX = 5
271IGNORE_PREFIX = wx
272
273#---------------------------------------------------------------------------
274# configuration options related to the HTML output
275#---------------------------------------------------------------------------
276GENERATE_HTML = NO # Only change in format output configs
277HTML_OUTPUT = html
278HTML_FILE_EXTENSION = .html
279HTML_HEADER = htmlheader.inc
280HTML_FOOTER = htmlfooter.inc
281HTML_STYLESHEET =
282HTML_ALIGN_MEMBERS = YES
283GENERATE_HTMLHELP = NO # Only change in format output configs
284HTML_DYNAMIC_SECTIONS = YES
285CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
286HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
287GENERATE_CHI = NO
288BINARY_TOC = NO
289TOC_EXPAND = NO
290DISABLE_INDEX = NO
291ENUM_VALUES_PER_LINE = 1
292GENERATE_TREEVIEW = NO
293TREEVIEW_WIDTH = 250
294
295#---------------------------------------------------------------------------
296# LaTeX Output Options
297#---------------------------------------------------------------------------
298
299GENERATE_LATEX = NO # Only change in format output configs
300LATEX_OUTPUT = latex
301LATEX_CMD_NAME = latex
302MAKEINDEX_CMD_NAME = makeindex
303COMPACT_LATEX = NO
304PAPER_TYPE = a4wide
305EXTRA_PACKAGES =
306LATEX_HEADER = latexdocstart.inc
307PDF_HYPERLINKS = YES
308USE_PDFLATEX = YES
309LATEX_BATCHMODE = YES
310LATEX_HIDE_INDICES = NO
311
312#---------------------------------------------------------------------------
313# RTF Output Options
314#---------------------------------------------------------------------------
315
316GENERATE_RTF = NO # Only change in format output configs
317RTF_OUTPUT = rtf
318COMPACT_RTF = NO
319RTF_HYPERLINKS = NO
320RTF_STYLESHEET_FILE =
321RTF_EXTENSIONS_FILE =
322
323#---------------------------------------------------------------------------
324# Man Page Output Options
325#---------------------------------------------------------------------------
326
327GENERATE_MAN = NO # Only change in format output configs
328MAN_OUTPUT = man
329MAN_EXTENSION = .3
330MAN_LINKS = NO
331
332#---------------------------------------------------------------------------
333# XML Output Options
334#---------------------------------------------------------------------------
335
336GENERATE_XML = NO # Only change in format output configs
337XML_OUTPUT = xml
338XML_SCHEMA =
339XML_DTD =
340XML_PROGRAMLISTING = NO
341
342#---------------------------------------------------------------------------
343# AutoGen Definitions Output Options
344#---------------------------------------------------------------------------
345
346GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
347
348#---------------------------------------------------------------------------
349# Perl Module Output Options
350#---------------------------------------------------------------------------
351
352GENERATE_PERLMOD = NO # Only change in format output configs
353PERLMOD_LATEX = YES
354PERLMOD_PRETTY = YES
355PERLMOD_MAKEVAR_PREFIX =
356
357#---------------------------------------------------------------------------
358# Preprocessor Options
359#---------------------------------------------------------------------------
360
361ENABLE_PREPROCESSING = YES
362MACRO_EXPANSION = NO
363EXPAND_ONLY_PREDEF = NO
364SEARCH_INCLUDES = YES
365INCLUDE_PATH =
366INCLUDE_FILE_PATTERNS =
367PREDEFINED =
368EXPAND_AS_DEFINED =
369SKIP_FUNCTION_MACROS = YES
370
371#---------------------------------------------------------------------------
372# Additions Related to External References
373#---------------------------------------------------------------------------
374
375TAGFILES =
376GENERATE_TAGFILE =
377ALLEXTERNALS = NO
378EXTERNAL_GROUPS = YES
379PERL_PATH = /usr/bin/perl
380
381#---------------------------------------------------------------------------
382# dot Tool Options
383#---------------------------------------------------------------------------
384
385CLASS_DIAGRAMS = YES
386MSCGEN_PATH =
387HIDE_UNDOC_RELATIONS = YES
388HAVE_DOT = YES
389CLASS_GRAPH = NO
390COLLABORATION_GRAPH = NO
391GROUP_GRAPHS = NO
392UML_LOOK = NO
393TEMPLATE_RELATIONS = NO
394INCLUDE_GRAPH = NO
395INCLUDED_BY_GRAPH = NO
396CALL_GRAPH = NO
397CALLER_GRAPH = NO
398GRAPHICAL_HIERARCHY = NO
399DIRECTORY_GRAPH = NO
400DOT_IMAGE_FORMAT = png
401DOT_PATH =
402DOTFILE_DIRS =
403DOT_GRAPH_MAX_NODES = 50
404MAX_DOT_GRAPH_DEPTH = 1000
405DOT_TRANSPARENT = NO
406DOT_MULTI_TARGETS = NO
407GENERATE_LEGEND = YES
408DOT_CLEANUP = YES
409
410#---------------------------------------------------------------------------
411# Search Engine Options
412#---------------------------------------------------------------------------
413
414SEARCHENGINE = NO
415
wxWidgets (Impactor)