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