]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/Doxyfile_inc
Fixed docs footer to bottom, and fixed up TOC on all main pages, and some overviews.
[wxWidgets.git] / docs / doxygen / Doxyfile_inc
CommitLineData
15b6757b 1#############################################################################
be151c9a 2## Name: Doxyfile_inc
de87600c 3## Purpose: Main configuration file for the wxWidgets manual
4514447c 4## Author: Francesco Montorsi
15b6757b 5## RCS-ID: $Id$
526954c5 6## Licence: wxWindows licence
15b6757b
FM
7#############################################################################
8
9#---------------------------------------------------------------------------
10da75d0 10# Project Options
15b6757b
FM
11#---------------------------------------------------------------------------
12
13DOXYFILE_ENCODING = UTF-8
14PROJECT_NAME = wxWidgets
14b682f7 15PROJECT_NUMBER = 2.9.5
20004800
BP
16PROJECT_BRIEF =
17PROJECT_LOGO = logo.png
15b6757b
FM
18OUTPUT_DIRECTORY = out
19CREATE_SUBDIRS = NO
20OUTPUT_LANGUAGE = English
21BRIEF_MEMBER_DESC = YES
7a4370a3 22REPEAT_BRIEF = YES
15b6757b
FM
23ABBREVIATE_BRIEF =
24ALWAYS_DETAILED_SEC = YES
25INLINE_INHERITED_MEMB = NO
10da75d0
BP
26FULL_PATH_NAMES = YES
27STRIP_FROM_PATH = "$(WXWIDGETS)/"
28STRIP_FROM_INC_PATH = "$(WXWIDGETS)/include/" \
29 "$(WXWIDGETS)/interface/"
15b6757b 30SHORT_NAMES = NO
4e021c31 31JAVADOC_AUTOBRIEF = YES
15b6757b
FM
32QT_AUTOBRIEF = NO
33MULTILINE_CPP_IS_BRIEF = NO
15b6757b
FM
34INHERIT_DOCS = YES
35SEPARATE_MEMBER_PAGES = NO
36TAB_SIZE = 4
37OPTIMIZE_OUTPUT_FOR_C = NO
38OPTIMIZE_OUTPUT_JAVA = NO
0d0dc584
BP
39OPTIMIZE_FOR_FORTRAN = NO
40OPTIMIZE_OUTPUT_VHDL = NO
15b6757b
FM
41BUILTIN_STL_SUPPORT = NO
42CPP_CLI_SUPPORT = NO
0d0dc584
BP
43SIP_SUPPORT = NO
44IDL_PROPERTY_SUPPORT = NO
23324ae1 45DISTRIBUTE_GROUP_DOC = YES
15b6757b 46SUBGROUPING = YES
0d0dc584
BP
47TYPEDEF_HIDES_STRUCT = NO
48SYMBOL_CACHE_SIZE = 0
15b6757b 49
94802614
FM
50# This is the most important part of the wxWidgets Doxyfile; aliases allow
51# us to keep the headers readable and "implement" wxWidgets-specific commands:
52
15b6757b 53#---------------------------------------------------------------------------
94802614 54# Aliases - for use when documenting C++ classes
15b6757b
FM
55#---------------------------------------------------------------------------
56
3051a44a
FM
57# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
58ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
59ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><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 for events emitted by this class:<div>"
60ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><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 for events emitted by this class:<div>"
61
62# aliases to be used in wxEvent-derived classes:
63ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><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>"
64ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><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>"
65
66# common event aliases:
8c6791e4
FM
67ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
68ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
69ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
70ALIASES += event{4}="</div>\li <span class='event'>\1, \2, \3, \4</span>:<div class='eventDesc'>"
71ALIASES += endEventTable="</div>\n"
15b6757b
FM
72
73# style aliases
0d0dc584 74ALIASES += beginStyleTable="\n<h2>Styles</h2><p>This class supports the following styles:</p><div>"
8c6791e4
FM
75ALIASES += style{1}="</div>\li <span class='style'>\1</span>:<div class='styleDesc'>"
76ALIASES += endStyleTable="</div>\n"
15b6757b
FM
77
78# extra style aliases
0d0dc584 79ALIASES += beginExtraStyleTable="\n<hr><h2>Extra styles</h2><p>This class supports the following extra styles:</p><div>"
8c6791e4 80ALIASES += endExtraStyleTable="</div>\n"
469e56bf 81
09a728e1
FM
82# flag aliases
83ALIASES += beginFlagTable="<div>"
84ALIASES += flag{1}="</div>\li <span class='flag'>\1</span>:<div class='flagDesc'>"
85ALIASES += endFlagTable="</div>\n"
86
94802614 87# creates appearance section: this should be used for all main GUI controls
e55d5694
VZ
88# that look different in different ports. genericAppearance can be used for the
89# controls that always look the same.
a300c745 90ALIASES += 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"
e55d5694 91ALIASES += genericAppearance{1}="\htmlonly <br><div><span class='appearance'>Appearance:</span><br><table class='appearance'><tr><td><img src='generic/\1' alt='Generic appearance' class='appearance'/></td></tr></table></div> \endhtmlonly"
94802614 92
ee49f540
FM
93# aliases for the creation of "named member groups"
94# USAGE: the first argument must not contain spaces and be a unique identifier
95# of the member group for the class being documented;
96# the second argument is the member group name and can contain spaces
97# See wxString as an usage example.
98# NOTE: no warnings are given for wrong member group names so be careful and check
99# the doxygen output to verify that there are no typos
100ALIASES += member_group_name{2}="<a name='\1'></a> \name \2"
101ALIASES += ref_member_group{2}="<a href='#\1' class='el'>\2</a>"
102
103
94802614
FM
104#---------------------------------------------------------------------------
105# Aliases - for use when documenting any C++ entity
106#---------------------------------------------------------------------------
107
e1ebc6f4 108# aliases for additional wx-specific infos
4cbfec15
FM
109ALIASES += 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>"
110ALIASES += 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>"
3c99e2fd 111ALIASES += category{3}="\ingroup group_class_\1 group_class_\2 group_class_\3 \n<div><span class='category'>Category:</span>&nbsp;&nbsp;<span class='category_text'>\ref group_class_\1, \ref group_class_\2, \ref group_class_\3</span></div>"
0d0dc584
BP
112ALIASES += library{1}="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>\ref page_libs_\1</span></div>"
113ALIASES += nolibrary="<h2></h2><div><span class='lib'>Library:</span>&nbsp;&nbsp;<span class='lib_text'>None; this class implementation is entirely header-based.</span></div>"
4f960cd1 114ALIASES += stdobjects="<span class='stdobj'>Predefined objects/pointers:</span>"
e1ebc6f4
FM
115
116# native implementation infos:
f59be7c6
FM
117ALIASES += nativeimpl{1}="<div><span class='impl'>Implementations:</span>&nbsp;&nbsp;native under \ref page_port_\1 port; a generic implementation is used elsewhere.</div>"
118ALIASES += 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>"
119ALIASES += 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>"
120ALIASES += 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>"
e1ebc6f4
FM
121
122# onlyfor infos:
03d4f7b9
FM
123# NOTE: we need to be able to retrieve these infos also from the XML output, thus
124# we use the \xmlonly and \endxmlonly commands to include custom XML tags
125ALIASES += 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"
126ALIASES += 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"
127ALIASES += 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"
128ALIASES += 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"
048398c7 129
12f5e1e7
BP
130# Use this in grouped global functions, and macros since they
131# wouldn't otherwise indicate what header they are defined in.
e1ebc6f4
FM
132ALIASES += header{1}="Include file:\n \verbatim #include <\1> \endverbatim"
133
15b6757b 134# some formatting aliases
44fe9ffc
FM
135ALIASES += true="<span class='literal'>true</span>"
136ALIASES += false="<span class='literal'>false</span>"
137ALIASES += NULL="<span class='literal'>NULL</span>"
8d740f72 138ALIASES += NUL="<span class='literal'>NUL</span>"
44fe9ffc
FM
139
140# NOTE: these are important as you can't write in the docs
141# just #ifdef since the # character is used by Doxygen
142# for explicit linking; use the following aliases instead!
143# However to avoid overwriting e.g. \if Doxygen command the _
144# character is postfixed
145ALIASES += ifdef_="<span class='literal'>\#ifdef</span>"
146ALIASES += ifndef_="<span class='literal'>\#ifndef</span>"
147ALIASES += if_="<span class='literal'>\#if</span>"
148ALIASES += endif_="<span class='literal'>\#endif</span>"
15b6757b 149
4514447c 150# table aliases for 2 and 3 column tables
a6d7c65b
VS
151ALIASES += beginTable="<table class='doctable' border='1' cellspacing='0' cellpadding='3'>"
152ALIASES += beginInvisibleTable="<table class='doctable' border='0' cellspacing='0' cellpadding='4'>"
4514447c
FM
153ALIASES += row2col{2}="<tr><td>\1</td> <td>\2</td></tr>"
154ALIASES += row2col{3}="<tr><td>\1</td> <td>\2,\3</td></tr>"
155ALIASES += row2col{4}="<tr><td>\1</td> <td>\2,\3,\4</td></tr>"
156ALIASES += row2col{5}="<tr><td>\1</td> <td>\2,\3,\4,\5</td></tr>"
157ALIASES += row2col{6}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6</td></tr>"
158ALIASES += row2col{7}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
159ALIASES += row2col{8}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
160ALIASES += row2col{9}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
161ALIASES += row2col{10}="<tr><td>\1</td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
162ALIASES += row3col{3}="<tr><td>\1</td> <td>\2</td> <td>\3</td></tr>"
163ALIASES += row3col{4}="<tr><td>\1</td> <td>\2</td> <td>\3,\4</td></tr>"
164ALIASES += row3col{5}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5</td></tr>"
165ALIASES += row3col{6}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6</td></tr>"
166ALIASES += row3col{7}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7</td></tr>"
167ALIASES += row3col{8}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8</td></tr>"
168ALIASES += row3col{9}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9</td></tr>"
169ALIASES += row3col{10}="<tr><td>\1</td> <td>\2</td> <td>\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
a302d595 170ALIASES += hdr3col{3}="<tr><th>\1</th> <th>\2</th> <th>\3</th></tr>"
a6d7c65b 171ALIASES += endTable="</table>"
a3465294 172
4514447c
FM
173# definition list aliases
174# a definition list currently is rendered as 2-column table but it may use as
175# well the <dl>, <dt> and <dd> HTML tags in future.
176# In any case a definition list differs from a table because of its semantic
177# nature and because it is always the association of a "title" with a "description"
178# (in contrast a table may have more than 2 columns of data)...
dc215c81 179ALIASES += beginDefList="<table class='doclist' border='1' cellspacing='0'>"
0aaf0255
FM
180ALIASES += itemdef{2}="<tr><td><span class='itemdef'>\1</span></td> <td>\2</td></tr>"
181ALIASES += itemdef{3}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3</td></tr>"
182ALIASES += itemdef{4}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4</td></tr>"
183ALIASES += itemdef{5}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5</td></tr>"
184ALIASES += itemdef{6}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6</td></tr>"
185ALIASES += itemdef{7}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7</td></tr>"
186ALIASES += itemdef{8}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8</td></tr>"
187ALIASES += itemdef{9}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9</td></tr>"
188ALIASES += itemdef{10}="<tr><td><span class='itemdef'>\1</span></td> <td>\2,\3,\4,\5,\6,\7,\8,\9,\10</td></tr>"
4514447c 189ALIASES += endDefList="</table>"
808b128e 190ALIASES += stock{3}="<tr><td><span class='itemdef'>\1</span></td> <td> @image html gtk-\2.png\n</td><td>\3</td></tr>"
4514447c 191
94802614
FM
192#---------------------------------------------------------------------------
193# Aliases - for use when documenting wxPerl/wxPython-specific parts
194#---------------------------------------------------------------------------
195
d54cf7ff 196# See ENABLED_SECTIONS configuration key for more info about these:
f09b5681 197ALIASES += beginWxPerlOnly="\if WXPERL_MANUAL <b>wxPerl Note:</b> "
d54cf7ff 198ALIASES += endWxPerlOnly="\endif"
a3465294 199
877b5c30
BP
200# This is to get around a bug in Doxygen that prevents use of '{' or '}'
201# inside of any aliased command in parameters.
202ALIASES += leftCurly="{"
203ALIASES += rightCurly="}"
204
94802614
FM
205#---------------------------------------------------------------------------
206# Aliases - for use when documenting samples
207#---------------------------------------------------------------------------
208
dff3fa53 209# For indicating a sample location
fe8aae41 210ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/\1"
94802614 211
57b2bba4 212# For refering to the corresponding sample in a class document or a overview
5d4cca7f
BP
213# Usually placed in the queue of @see
214ALIASES += sample{1}="\ref page_samples_\1"
94802614 215
57b2bba4
BP
216# For generating a general description for a sample
217# \1 could be a class or an overview or a descriptive sentence
5d4cca7f
BP
218# Shall be replaced by manual written description soon
219ALIASES += sampleabout{1}="This sample demonstrates \1."
94802614 220
5d4cca7f
BP
221# For indicating the necessary condition of a sample or a class
222# \1 is the wxUSE_XXX macro
223ALIASES += 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."
224ALIASES += 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."
225
15b6757b 226#---------------------------------------------------------------------------
10da75d0 227# Build Options
15b6757b 228#---------------------------------------------------------------------------
10da75d0 229
15b6757b
FM
230EXTRACT_ALL = YES
231EXTRACT_PRIVATE = NO
232EXTRACT_STATIC = YES
233EXTRACT_LOCAL_CLASSES = YES
234EXTRACT_LOCAL_METHODS = NO
235EXTRACT_ANON_NSPACES = YES
23324ae1
FM
236HIDE_UNDOC_MEMBERS = NO
237HIDE_UNDOC_CLASSES = NO
15b6757b
FM
238HIDE_FRIEND_COMPOUNDS = NO
239HIDE_IN_BODY_DOCS = NO
240INTERNAL_DOCS = NO
241CASE_SENSE_NAMES = NO
242HIDE_SCOPE_NAMES = NO
243SHOW_INCLUDE_FILES = YES
244INLINE_INFO = YES
245SORT_MEMBER_DOCS = YES
0d0dc584
BP
246SORT_BRIEF_DOCS = NO # Don't set to YES, it renders our named groups out of order.
247SORT_GROUP_NAMES = YES
15b6757b
FM
248SORT_BY_SCOPE_NAME = NO
249GENERATE_TODOLIST = YES
250GENERATE_TESTLIST = YES
251GENERATE_BUGLIST = YES
252GENERATE_DEPRECATEDLIST= YES
d54cf7ff
FM
253
254# can contain WXPERL_MANUAL, WXPYTHON_MANUAL keywords
dc215c81 255ENABLED_SECTIONS = WXPERL_MANUAL WXPYTHON_MANUAL
d54cf7ff 256
15b6757b 257MAX_INITIALIZER_LINES = 30
10da75d0 258SHOW_USED_FILES = NO
23324ae1 259SHOW_DIRECTORIES = YES
0d0dc584
BP
260SHOW_FILES = YES
261SHOW_NAMESPACES = NO
6783cae4 262FILE_VERSION_FILTER =
0d0dc584 263LAYOUT_FILE = DoxygenLayout.xml
15b6757b
FM
264
265#---------------------------------------------------------------------------
10da75d0 266# Warning and Progress Message Options
15b6757b 267#---------------------------------------------------------------------------
10da75d0 268
f159c6b5 269QUIET = YES
15b6757b 270WARNINGS = YES
90a47090 271WARN_IF_UNDOCUMENTED = YES
15b6757b 272WARN_IF_DOC_ERROR = YES
23324ae1 273WARN_NO_PARAMDOC = YES
15b6757b 274WARN_FORMAT = "$file:$line: $text "
4411a6b6 275WARN_LOGFILE = doxygen.log
15b6757b
FM
276
277#---------------------------------------------------------------------------
10da75d0 278# Input File Options
15b6757b 279#---------------------------------------------------------------------------
10da75d0 280
c83e60aa 281INPUT = ./mainpages ./groups ./overviews ../../interface
15b6757b
FM
282INPUT_ENCODING = UTF-8
283FILE_PATTERNS = *.h *.txt
284RECURSIVE = YES
6783cae4 285EXCLUDE =
15b6757b 286EXCLUDE_SYMLINKS = NO
6783cae4
FM
287EXCLUDE_PATTERNS =
288EXCLUDE_SYMBOLS =
29f86fc1 289EXAMPLE_PATH = ../
15b6757b 290EXAMPLE_PATTERNS = *
29f86fc1 291EXAMPLE_RECURSIVE = NO
4411a6b6 292IMAGE_PATH = images
6783cae4
FM
293INPUT_FILTER =
294FILTER_PATTERNS =
15b6757b
FM
295FILTER_SOURCE_FILES = NO
296
297#---------------------------------------------------------------------------
10da75d0 298# Source Browsing Options
15b6757b 299#---------------------------------------------------------------------------
10da75d0 300
15b6757b
FM
301SOURCE_BROWSER = NO
302INLINE_SOURCES = NO
303STRIP_CODE_COMMENTS = YES
304REFERENCED_BY_RELATION = NO
305REFERENCES_RELATION = NO
306REFERENCES_LINK_SOURCE = YES
307USE_HTAGS = NO
308VERBATIM_HEADERS = NO
309
310#---------------------------------------------------------------------------
10da75d0 311# Alphabetical Class Index Options
15b6757b 312#---------------------------------------------------------------------------
10da75d0 313
15b6757b
FM
314ALPHABETICAL_INDEX = YES
315COLS_IN_ALPHA_INDEX = 5
316IGNORE_PREFIX = wx
317
318#---------------------------------------------------------------------------
319# configuration options related to the HTML output
320#---------------------------------------------------------------------------
2a6585b8 321GENERATE_HTML = NO # Only change in format output configs
15b6757b
FM
322HTML_OUTPUT = html
323HTML_FILE_EXTENSION = .html
20004800
BP
324HTML_HEADER = custom_header.html
325HTML_FOOTER = custom_footer.html
326HTML_STYLESHEET = custom_stylesheet.css
3e14a8d3 327HTML_EXTRA_FILES = jquery-1.3.2.min.js
20004800
BP
328HTML_COLORSTYLE_HUE =
329HTML_COLORSTYLE_SAT = 255
330HTML_COLORSTYLE_GAMMA = 100
331HTML_TIMESTAMP = YES
15b6757b 332HTML_ALIGN_MEMBERS = YES
f159c6b5 333HTML_DYNAMIC_SECTIONS = YES
7e6ab750
FM
334DISABLE_INDEX = NO
335ENUM_VALUES_PER_LINE = 1
20004800
BP
336GENERATE_TREEVIEW = NO
337USE_INLINE_TREES = NO
7e6ab750 338TREEVIEW_WIDTH = 250
20004800 339EXT_LINKS_IN_WINDOW = YES
7e6ab750 340FORMULA_FONTSIZE = 10
20004800 341FORMULA_TRANSPARENT = YES
7e6ab750
FM
342
343#---------------------------------------------------------------------------
344# configuration options related to the CHM output
345#---------------------------------------------------------------------------
346
0d0dc584 347GENERATE_HTMLHELP = NO # Only change in format output configs
2a6585b8
BP
348CHM_FILE = ..\wx.chm # NOTE: Windows style separator needed
349HHC_LOCATION = hhc.exe # Don't modify, see Doxyfile_chm for info
15b6757b
FM
350GENERATE_CHI = NO
351BINARY_TOC = NO
352TOC_EXPAND = NO
7e6ab750
FM
353
354#---------------------------------------------------------------------------
355# configuration options related to the Qt Help Project output
356#---------------------------------------------------------------------------
357
358GENERATE_QHP = NO # Only change in format output configs
3051a44a 359QCH_FILE =
0d0dc584
BP
360QHP_NAMESPACE = org.wxwidgets.doxygen
361QHP_VIRTUAL_FOLDER = doc
3051a44a 362QHG_LOCATION =
7e6ab750
FM
363
364#---------------------------------------------------------------------------
365# configuration options related to the Docset output
366#---------------------------------------------------------------------------
367
368GENERATE_DOCSET = NO # Only change in format output configs
369DOCSET_FEEDNAME = "wxWidgets 2.9"
370DOCSET_BUNDLE_ID = org.wxwidgets.doxygen.wx29
371DOCSET_PUBLISHER_ID = org.wxwidgets.doxygen
372DOCSET_PUBLISHER_NAME = wxWidgets Team
15b6757b
FM
373
374#---------------------------------------------------------------------------
10da75d0 375# LaTeX Output Options
15b6757b 376#---------------------------------------------------------------------------
10da75d0 377
2a6585b8 378GENERATE_LATEX = NO # Only change in format output configs
15b6757b
FM
379LATEX_OUTPUT = latex
380LATEX_CMD_NAME = latex
381MAKEINDEX_CMD_NAME = makeindex
382COMPACT_LATEX = NO
383PAPER_TYPE = a4wide
6783cae4 384EXTRA_PACKAGES =
d0894365 385LATEX_HEADER = latexdocstart.inc
f4eb5ee6
SC
386PDF_HYPERLINKS = YES
387USE_PDFLATEX = YES
388LATEX_BATCHMODE = YES
15b6757b
FM
389LATEX_HIDE_INDICES = NO
390
391#---------------------------------------------------------------------------
10da75d0 392# RTF Output Options
15b6757b 393#---------------------------------------------------------------------------
10da75d0 394
2a6585b8 395GENERATE_RTF = NO # Only change in format output configs
15b6757b
FM
396RTF_OUTPUT = rtf
397COMPACT_RTF = NO
398RTF_HYPERLINKS = NO
6783cae4
FM
399RTF_STYLESHEET_FILE =
400RTF_EXTENSIONS_FILE =
15b6757b
FM
401
402#---------------------------------------------------------------------------
10da75d0 403# Man Page Output Options
15b6757b 404#---------------------------------------------------------------------------
10da75d0 405
2a6585b8 406GENERATE_MAN = NO # Only change in format output configs
15b6757b
FM
407MAN_OUTPUT = man
408MAN_EXTENSION = .3
409MAN_LINKS = NO
410
411#---------------------------------------------------------------------------
10da75d0 412# XML Output Options
15b6757b 413#---------------------------------------------------------------------------
10da75d0 414
2a6585b8 415GENERATE_XML = NO # Only change in format output configs
15b6757b 416XML_OUTPUT = xml
6783cae4
FM
417XML_SCHEMA =
418XML_DTD =
09ad05fa 419XML_PROGRAMLISTING = NO
15b6757b
FM
420
421#---------------------------------------------------------------------------
10da75d0 422# AutoGen Definitions Output Options
15b6757b 423#---------------------------------------------------------------------------
10da75d0 424
2a6585b8 425GENERATE_AUTOGEN_DEF = NO # Only change in format output configs
15b6757b
FM
426
427#---------------------------------------------------------------------------
10da75d0 428# Perl Module Output Options
15b6757b 429#---------------------------------------------------------------------------
10da75d0 430
2a6585b8 431GENERATE_PERLMOD = NO # Only change in format output configs
30738aae 432PERLMOD_LATEX = YES
15b6757b 433PERLMOD_PRETTY = YES
de87600c 434PERLMOD_MAKEVAR_PREFIX =
15b6757b
FM
435
436#---------------------------------------------------------------------------
10da75d0 437# Preprocessor Options
15b6757b 438#---------------------------------------------------------------------------
10da75d0 439
15b6757b
FM
440ENABLE_PREPROCESSING = YES
441MACRO_EXPANSION = NO
442EXPAND_ONLY_PREDEF = NO
443SEARCH_INCLUDES = YES
6783cae4
FM
444INCLUDE_PATH =
445INCLUDE_FILE_PATTERNS =
446PREDEFINED =
447EXPAND_AS_DEFINED =
15b6757b
FM
448SKIP_FUNCTION_MACROS = YES
449
450#---------------------------------------------------------------------------
10da75d0 451# Additions Related to External References
15b6757b 452#---------------------------------------------------------------------------
10da75d0 453
6783cae4 454TAGFILES =
2a6585b8 455GENERATE_TAGFILE =
15b6757b
FM
456ALLEXTERNALS = NO
457EXTERNAL_GROUPS = YES
458PERL_PATH = /usr/bin/perl
459
460#---------------------------------------------------------------------------
10da75d0 461# dot Tool Options
15b6757b 462#---------------------------------------------------------------------------
10da75d0 463
15b6757b
FM
464CLASS_DIAGRAMS = YES
465MSCGEN_PATH =
466HIDE_UNDOC_RELATIONS = YES
467HAVE_DOT = YES
0d0dc584
BP
468DOT_FONTNAME = FreeSans
469DOT_FONTSIZE = 10
3051a44a 470DOT_FONTPATH =
0d0dc584 471CLASS_GRAPH = YES
15b6757b
FM
472COLLABORATION_GRAPH = NO
473GROUP_GRAPHS = NO
474UML_LOOK = NO
475TEMPLATE_RELATIONS = NO
476INCLUDE_GRAPH = NO
477INCLUDED_BY_GRAPH = NO
478CALL_GRAPH = NO
479CALLER_GRAPH = NO
480GRAPHICAL_HIERARCHY = NO
481DIRECTORY_GRAPH = NO
482DOT_IMAGE_FORMAT = png
6783cae4 483DOTFILE_DIRS =
15b6757b
FM
484DOT_GRAPH_MAX_NODES = 50
485MAX_DOT_GRAPH_DEPTH = 1000
486DOT_TRANSPARENT = NO
487DOT_MULTI_TARGETS = NO
488GENERATE_LEGEND = YES
489DOT_CLEANUP = YES
490
2d283194
FM
491# instead of setting a value for DOT_PATH it's easier and more portable to
492# put your dot utility in the PATH; if you are on a Unix system this is usually
493# done automatically; if you're on Windows you'll need to install GraphViz tools
494# and then manually add it to the PATH environment variable
495DOT_PATH =
496
15b6757b 497#---------------------------------------------------------------------------
10da75d0 498# Search Engine Options
15b6757b 499#---------------------------------------------------------------------------
10da75d0 500
2a6585b8
BP
501SEARCHENGINE = NO
502