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